> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IDashboardDefinition - Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md) - Kind: interface - Stability: alpha - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/dashboard/dashboard.ts > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard definition represents modified or created dashboard **Signature:** ```typescript export interface IDashboardDefinition extends IDashboardBase, IAccessControlAware, Partial ``` **Extends:** [IDashboardBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardbase/index.md), [IAccessControlAware](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iaccesscontrolaware/index.md), Partial<[IDashboardObjectIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardobjectidentity/index.md)> ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [attributeFilterConfigs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionattributefilterconfigs) | `readonly` | [IDashboardAttributeFilterConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardattributefilterconfig/index.md)[] | **_(ALPHA)_** _(Optional)_ Dashboard extended attribute filter configs | | [dateFilterConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondatefilterconfig) | `readonly` | [IDashboardDateFilterConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddatefilterconfig/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard extended common date filter config | | [dateFilterConfigs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondatefilterconfigs) | `readonly` | [IDashboardDateFilterConfigItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddatefilterconfigitem/index.md)[] | **_(ALPHA)_** _(Optional)_ Dashboard extended date filters with date data set/dimension configs | | [disableCrossFiltering?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondisablecrossfiltering) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Disables cross filtering for this dashboard. | | [disableFilterViews?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondisablefilterviews) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Disables listing and saving of filter views for this dashboard. | | [disablePersistentFiltersAcrossTabs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondisablepersistentfiltersacrosstabs) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Disables persistent filters across tabs for this dashboard. | | [disableUserFilterReset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondisableuserfilterreset) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Disables reset of user filters for this dashboard. | | [disableUserFilterSave?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiondisableuserfiltersave) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Disables save of user filters for this dashboard. | | [evaluationFrequency?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionevaluationfrequency) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Evaluation frequency of alerts for the dashboard. | | [filterContext?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionfiltercontext) | `readonly` | [IFilterContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiltercontext/index.md) \| [IFilterContextDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiltercontextdefinition/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard filter context, or temporary filter context | | [layout?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionlayout) | `readonly` | [IDashboardLayout](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardlayout/index.md)<TWidget> | **_(ALPHA)_** _(Optional)_ The layout of the dashboard determines the dashboard widgets [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) and where they are rendered | | [measureValueFilterConfigs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionmeasurevaluefilterconfigs) | `readonly` | [IDashboardMeasureValueFilterConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardmeasurevaluefilterconfig/index.md)[] | **_(ALPHA)_** _(Optional)_ Dashboard extended measure value filter configs | | [parameters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionparameters) | `readonly` | [IDashboardParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md)[] | **_(ALPHA)_** _(Optional)_ Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata; saves emit parameters per tab on [IDashboardTab.parameters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardtab/index.md#idashboardtabparameters) instead. Honored on load only when no tab carries parameters. | | [plugins?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionplugins) | `readonly` | [IDashboardPluginLink](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardpluginlink/index.md)[] | **_(ALPHA)_** _(Optional)_ Plugins to use on this dashboard. | | [sectionHeadersDateDataSet?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitionsectionheadersdatedataset) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** _(Optional)_ Date dataset to use for filtering metrics in section header rich text. | | [tabs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiontabs) | `readonly` | [IDashboardTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardtab/index.md)<TWidget>[] | **_(ALPHA)_** _(Optional)_ Optional tabs configuration; when defined, the dashboard renders as a tabbed interface. Each tab has its own layout, filter context and filter configs. | | [timezoneConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiontimezoneconfig) | `readonly` | [IDashboardTimezoneConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardtimezoneconfig/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard-level timezone configuration. | | [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddefinition/index.md#idashboarddefinitiontype) | `readonly` | "IDashboard" | **_(ALPHA)_** | ## Property details ### IDashboardDefinition.attributeFilterConfigs > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard extended attribute filter configs **Signature:** ```typescript readonly attributeFilterConfigs?: IDashboardAttributeFilterConfig[]; ``` ### IDashboardDefinition.dateFilterConfig > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard extended common date filter config **Signature:** ```typescript readonly dateFilterConfig?: IDashboardDateFilterConfig; ``` ### IDashboardDefinition.dateFilterConfigs > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard extended date filters with date data set/dimension configs **Signature:** ```typescript readonly dateFilterConfigs?: IDashboardDateFilterConfigItem[]; ``` ### IDashboardDefinition.disableCrossFiltering > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Disables cross filtering for this dashboard. **Signature:** ```typescript readonly disableCrossFiltering?: boolean; ``` ### IDashboardDefinition.disableFilterViews > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Disables listing and saving of filter views for this dashboard. **Signature:** ```typescript readonly disableFilterViews?: boolean; ``` ### IDashboardDefinition.disablePersistentFiltersAcrossTabs > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Disables persistent filters across tabs for this dashboard. **Signature:** ```typescript readonly disablePersistentFiltersAcrossTabs?: boolean; ``` ### IDashboardDefinition.disableUserFilterReset > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Disables reset of user filters for this dashboard. **Signature:** ```typescript readonly disableUserFilterReset?: boolean; ``` ### IDashboardDefinition.disableUserFilterSave > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Disables save of user filters for this dashboard. **Signature:** ```typescript readonly disableUserFilterSave?: boolean; ``` ### IDashboardDefinition.evaluationFrequency > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Evaluation frequency of alerts for the dashboard. **Signature:** ```typescript readonly evaluationFrequency?: string; ``` ### IDashboardDefinition.filterContext > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard filter context, or temporary filter context **Signature:** ```typescript readonly filterContext?: IFilterContext | IFilterContextDefinition; ``` ### IDashboardDefinition.layout > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > The layout of the dashboard determines the dashboard widgets [IWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iwidget/index.md) and where they are rendered **Signature:** ```typescript readonly layout?: IDashboardLayout; ``` ### IDashboardDefinition.measureValueFilterConfigs > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard extended measure value filter configs **Signature:** ```typescript readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[]; ``` ### IDashboardDefinition.parameters > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata; saves emit parameters per tab on [IDashboardTab.parameters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardtab/index.md#idashboardtabparameters) instead. Honored on load only when no tab carries parameters. **Signature:** ```typescript readonly parameters?: IDashboardParameter[]; ``` ### IDashboardDefinition.plugins > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Plugins to use on this dashboard. **Signature:** ```typescript readonly plugins?: IDashboardPluginLink[]; ``` ### IDashboardDefinition.sectionHeadersDateDataSet > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Date dataset to use for filtering metrics in section header rich text. **Signature:** ```typescript readonly sectionHeadersDateDataSet?: ObjRef; ``` ### IDashboardDefinition.tabs > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Optional tabs configuration; when defined, the dashboard renders as a tabbed interface. Each tab has its own layout, filter context and filter configs. **Signature:** ```typescript readonly tabs?: IDashboardTab[]; ``` ### IDashboardDefinition.timezoneConfig > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Dashboard-level timezone configuration. **Signature:** ```typescript readonly timezoneConfig?: IDashboardTimezoneConfig; ``` ### IDashboardDefinition.type > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript readonly type: "IDashboard"; ```