IDashboardVisualizationSwitcherProps
Visualization switcher widget props.
export interface IDashboardVisualizationSwitcherProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | undefined | (Optional) Identifier of visualization currently active. | ||
(ALPHA) (Optional) Backend to work with. | |||
number | (ALPHA) (Optional) Height of the visualization switcher widget container. | ||
number | (ALPHA) (Optional) Width of the visualization switcher widget container. | ||
(ALPHA) (Optional) Data for export in export mode. | |||
(Optional) | |||
(Optional) | |||
(Optional) | |||
Definition of insight widget to render. | |||
string | (ALPHA) (Optional) Workspace where the Insight widget exists. |
Property details
IDashboardVisualizationSwitcherProps.activeVisualizationIdproperty
Identifier of visualization currently active.
activeVisualizationId?: string | undefined;
IDashboardVisualizationSwitcherProps.backendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Backend to work with.
backend?: IAnalyticalBackend;
Remarks
Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the component MUST be rendered within an existing BackendContext.
IDashboardVisualizationSwitcherProps.clientHeightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Height of the visualization switcher widget container.
clientHeight?: number;
IDashboardVisualizationSwitcherProps.clientWidthpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Width of the visualization switcher widget container.
clientWidth?: number;
IDashboardVisualizationSwitcherProps.exportDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Data for export in export mode.
exportData?: WidgetExportData;
IDashboardVisualizationSwitcherProps.onErrorproperty
onError?: OnError;
IDashboardVisualizationSwitcherProps.onExportReadyproperty
onExportReady?: OnExportReady;
IDashboardVisualizationSwitcherProps.onLoadingChangedproperty
onLoadingChanged?: OnLoadingChanged;
IDashboardVisualizationSwitcherProps.screenproperty
screen: ScreenSize;
IDashboardVisualizationSwitcherProps.widgetproperty
Definition of insight widget to render.
widget: IVisualizationSwitcherWidget;
IDashboardVisualizationSwitcherProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workspace where the Insight widget exists.
workspace?: string;
Remarks
Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the component MUST be rendered within an existing WorkspaceContext.