IDashboard

IDashboard.attributeFilterConfigspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard extended attribute filter configs

readonly attributeFilterConfigs?: IDashboardAttributeFilterConfig[];

IDashboard.dataSetspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Data sets related to the dashboard, as defined by the includes directive

readonly dataSets?: IDataSetMetadataObject[];

IDashboard.dateFilterConfigpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard extended common date filter config

readonly dateFilterConfig?: IDashboardDateFilterConfig;

IDashboard.dateFilterConfigspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard extended date filters with date data set/dimension configs

readonly dateFilterConfigs?: IDashboardDateFilterConfigItem[];

IDashboard.disableCrossFilteringpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Disables cross filtering for this dashboard.

readonly disableCrossFiltering?: boolean;

IDashboard.disableFilterViewspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Disables listing and saving of filter views for this dashboard.

readonly disableFilterViews?: boolean;

IDashboard.disablePersistentFiltersAcrossTabspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Disables persistent filters across tabs for this dashboard.

readonly disablePersistentFiltersAcrossTabs?: boolean;

IDashboard.disableUserFilterResetpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Disables reset of user filters for this dashboard.

readonly disableUserFilterReset?: boolean;

IDashboard.disableUserFilterSavepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Disables save of user filters for this dashboard.

readonly disableUserFilterSave?: boolean;

IDashboard.evaluationFrequencypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Override the default evaluation frequency for the dashboard.

readonly evaluationFrequency?: string;

IDashboard.filterContextpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard filter context, or temporary filter context (temporary filter context is used to override original filter context during the export)

readonly filterContext?: IFilterContext | ITempFilterContext;

IDashboard.layoutpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

The layout of the dashboard determines the dashboard widgets IWidget and where they are rendered

readonly layout?: IDashboardLayout<TWidget>;

IDashboard.measureValueFilterConfigspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard extended measure value filter configs

readonly measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];

IDashboard.parameterspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Legacy dashboard-level parameters. Preserved as a read-only fallback for legacy metadata; saves emit parameters per tab on IDashboardTab.parameters instead. Honored on load only when no tab carries parameters.

readonly parameters?: IDashboardParameter[];

IDashboard.pluginspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Plugins used on this dashboard.

readonly plugins?: IDashboardPluginLink[];

IDashboard.sectionHeadersDateDataSetpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Date dataset to use for filtering metrics in section header rich text.

readonly sectionHeadersDateDataSet?: ObjRef;

IDashboard.tabspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Optional tabs configuration; when defined, the dashboard renders as a tabbed interface. Each tab has its own layout, filter context and filter configs.

readonly tabs?: IDashboardTab<TWidget>[];

IDashboard.timezoneConfigpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard-level timezone configuration.

readonly timezoneConfig?: IDashboardTimezoneConfig;

IDashboard.typepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

readonly type: "IDashboard";