IDashboardFocusObject
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Specifies the focus object for the dashboard.
export interface IDashboardFocusObject
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) If provided, the dashboard will be opened in the context of the given automation. This means, that target widget will be focused in the dashboard, and filter context will be set to the one used in the automation. | |||
(BETA) (Optional) If provided, the dashboard will be opened in the context of the given visualization. This means, that target visualizations represented by widgets will be focused in the dashboard. | |||
string | (BETA) (Optional) If provided, the dashboard will be opened in the context of the given widget. This means, that target widget will be focused in the dashboard. |
Property details
IDashboardFocusObject.automationIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If provided, the dashboard will be opened in the context of the given automation. This means, that target widget will be focused in the dashboard, and filter context will be set to the one used in the automation.
automationId?: Identifier;
IDashboardFocusObject.visualizationIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If provided, the dashboard will be opened in the context of the given visualization. This means, that target visualizations represented by widgets will be focused in the dashboard.
visualizationId?: Identifier;
IDashboardFocusObject.widgetIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If provided, the dashboard will be opened in the context of the given widget. This means, that target widget will be focused in the dashboard.
widgetId?: string;
Remarks
This property is not a formal MD identifier