IDashboardTab
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard tab definition.
export interface IDashboardTab<TWidget = IDashboardWidget>
Remarks
Each tab can have its own layout and its own filter context. Tabs are optional and dashboards without tabs continue to work using the root layout and filter context.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Dashboard extended attribute filter configs | |||
(ALPHA) (Optional) Dashboard tab common date filter config | |||
(ALPHA) (Optional) Dashboard tab date filters with date data set/dimension configs | |||
(ALPHA) (Optional) Tab-specific filter context. | |||
(ALPHA) (Optional) Dashboard filter groups config. It allows to group some filters from filter context into a group. It groups them only visually. Does not affect a computation. This is usually used on dashboards with many filters to improve readability. If not defined, filters are displayed ungrouped as defined in single context. | |||
IDashboardLayout<TWidget> | (ALPHA) (Optional) Complete layout definition for this tab. | ||
string | (ALPHA) Unique identifier of the tab (stable within dashboard). | ||
(ALPHA) (Optional) Dashboard extended measure value filter configs | |||
(ALPHA) (Optional) Tab-scoped parameter overrides. Each entry references a workspace parameter and optionally pins a dashboard-scope value, label, and mode. A parameter affects only the widgets on the tab where it is configured; the same ref may be added independently to multiple tabs with independent values, labels, and modes. | |||
string | (ALPHA) Display title of the tab. |
Property details
IDashboardTab.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
attributeFilterConfigs?: IDashboardAttributeFilterConfig[];
IDashboardTab.dateFilterConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard tab common date filter config
dateFilterConfig?: IDashboardDateFilterConfig;
IDashboardTab.dateFilterConfigspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard tab date filters with date data set/dimension configs
dateFilterConfigs?: IDashboardDateFilterConfigItem[];
IDashboardTab.filterContextpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Tab-specific filter context.
filterContext?: IFilterContext | ITempFilterContext;
IDashboardTab.filterGroupsConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard filter groups config. It allows to group some filters from filter context into a group. It groups them only visually. Does not affect a computation. This is usually used on dashboards with many filters to improve readability. If not defined, filters are displayed ungrouped as defined in single context.
filterGroupsConfig?: IDashboardFilterGroupsConfig;
IDashboardTab.layoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Complete layout definition for this tab.
layout?: IDashboardLayout<TWidget>;
IDashboardTab.localIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Unique identifier of the tab (stable within dashboard).
localIdentifier: string;
IDashboardTab.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
measureValueFilterConfigs?: IDashboardMeasureValueFilterConfig[];
IDashboardTab.parameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Tab-scoped parameter overrides. Each entry references a workspace parameter and optionally pins a dashboard-scope value, label, and mode. A parameter affects only the widgets on the tab where it is configured; the same ref may be added independently to multiple tabs with independent values, labels, and modes.
parameters?: IDashboardParameter[];
IDashboardTab.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Display title of the tab.
title: string;