IDrillToDashboard
Drill to dashboard
export interface IDrillToDashboard extends IDrill
Extends: IDrill
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string[] | (Optional) Dashboard-level filters that should be excluded (opt-out). | ||
(Optional) Source insight filters that are explicitly included (opt-in). | |||
(Optional) Source measure-level filters that are explicitly included (opt-in). | |||
(Optional) Target dashboard ref. If not specified, then this is a drill to self - activating such drill will not switch to a different dashboard but will instead set dashboard filters to ‘focus’ on the drilled attribute element IF a filter for that attribute is defined for the dashboard. Example: dashboard shows several for company departments. It is possible to filter the entire dashboard by department. A column chart showing cost by department has drill to dashboard set without ’target’. When user clicks a column, the dashboard’s department filter will be set to the department that the clicked column represents. | |||
string | (ALPHA) (Optional) Target tab identifier within the dashboard. When specified, the drill will navigate to the specific tab. If not specified, the dashboard will open with its default/first tab. | ||
“in-place” | Drill transition | ||
“drillToDashboard” | Drill type |
Property details
IDrillToDashboard.ignoredDashboardFiltersproperty
Dashboard-level filters that should be excluded (opt-out).
ignoredDashboardFilters?: string[];
IDrillToDashboard.includedSourceInsightFiltersObjRefsproperty
Source insight filters that are explicitly included (opt-in).
includedSourceInsightFiltersObjRefs?: SourceInsightFilterObjRef[];
IDrillToDashboard.includedSourceMeasureFiltersObjRefsproperty
Source measure-level filters that are explicitly included (opt-in).
includedSourceMeasureFiltersObjRefs?: SourceMeasureFilterObjRef[];
IDrillToDashboard.targetproperty
Target dashboard ref. If not specified, then this is a drill to self - activating such drill will not switch to a different dashboard but will instead set dashboard filters to ‘focus’ on the drilled attribute element IF a filter for that attribute is defined for the dashboard.
Example: dashboard shows several for company departments. It is possible to filter the entire dashboard by department. A column chart showing cost by department has drill to dashboard set without ’target’. When user clicks a column, the dashboard’s department filter will be set to the department that the clicked column represents.
target?: ObjRef;
IDrillToDashboard.targetTabLocalIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Target tab identifier within the dashboard. When specified, the drill will navigate to the specific tab. If not specified, the dashboard will open with its default/first tab.
targetTabLocalIdentifier?: string;
IDrillToDashboard.transitionproperty
Drill transition
transition: "in-place";
IDrillToDashboard.typeproperty
Drill type
type: "drillToDashboard";