> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IDashboard - 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). > Analytical dashboard consists of widgets (widgets are kpis or insights with additional settings - drilling and alerting), layout (which defines rendering and ordering of these widgets), and filter context (configured attribute and date filters). It's also possible to setup scheduled emails for the dashboard (user will receive an email with the exported dashboard attached at the specified time interval), and optionally extended date filter config. **Signature:** ```typescript export interface IDashboard extends IDashboardBase, IDashboardObjectIdentity, Readonly>, Readonly, IAccessControlAware ``` **Extends:** [IDashboardBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardbase/index.md), [IDashboardObjectIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardobjectidentity/index.md), Readonly<Required<[IAuditableDates](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iauditabledates/index.md)>>, Readonly<[IAuditableUsers](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iauditableusers/index.md)>, [IAccessControlAware](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iaccesscontrolaware/index.md) ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [attributeFilterConfigs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboardattributefilterconfigs) | `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 | | [dataSets?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboarddatasets) | `readonly` | [IDataSetMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasetmetadataobject/index.md)[] | **_(ALPHA)_** _(Optional)_ Data sets related to the dashboard, as defined by the includes directive | | [dateFilterConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboarddatefilterconfig) | `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.idashboard/index.md#idashboarddatefilterconfigs) | `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.idashboard/index.md#idashboarddisablecrossfiltering) | `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.idashboard/index.md#idashboarddisablefilterviews) | `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.idashboard/index.md#idashboarddisablepersistentfiltersacrosstabs) | `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.idashboard/index.md#idashboarddisableuserfilterreset) | `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.idashboard/index.md#idashboarddisableuserfiltersave) | `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.idashboard/index.md#idashboardevaluationfrequency) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Override the default evaluation frequency for the dashboard. | | [filterContext?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboardfiltercontext) | `readonly` | [IFilterContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiltercontext/index.md) \| [ITempFilterContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itempfiltercontext/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard filter context, or temporary filter context (temporary filter context is used to override original filter context during the export) | | [layout?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboardlayout) | `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.idashboard/index.md#idashboardmeasurevaluefilterconfigs) | `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.idashboard/index.md#idashboardparameters) | `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.idashboard/index.md#idashboardplugins) | `readonly` | [IDashboardPluginLink](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardpluginlink/index.md)[] | **_(ALPHA)_** _(Optional)_ Plugins used on this dashboard. | | [sectionHeadersDateDataSet?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboard/index.md#idashboardsectionheadersdatedataset) | `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.idashboard/index.md#idashboardtabs) | `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.idashboard/index.md#idashboardtimezoneconfig) | `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.idashboard/index.md#idashboardtype) | `readonly` | "IDashboard" | **_(ALPHA)_** | ## Property details ### IDashboard.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[]; ``` ### IDashboard.dataSets > **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). > Data sets related to the dashboard, as defined by the includes directive **Signature:** ```typescript readonly dataSets?: IDataSetMetadataObject[]; ``` ### IDashboard.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; ``` ### IDashboard.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[]; ``` ### IDashboard.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; ``` ### IDashboard.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; ``` ### IDashboard.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; ``` ### IDashboard.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; ``` ### IDashboard.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; ``` ### IDashboard.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). > Override the default evaluation frequency for the dashboard. **Signature:** ```typescript readonly evaluationFrequency?: string; ``` ### IDashboard.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 (temporary filter context is used to override original filter context during the export) **Signature:** ```typescript readonly filterContext?: IFilterContext | ITempFilterContext; ``` ### IDashboard.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; ``` ### IDashboard.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[]; ``` ### IDashboard.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[]; ``` ### IDashboard.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 used on this dashboard. **Signature:** ```typescript readonly plugins?: IDashboardPluginLink[]; ``` ### IDashboard.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; ``` ### IDashboard.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[]; ``` ### IDashboard.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; ``` ### IDashboard.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"; ```