IAnalyticalDesignerVisualizationInfoProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the region with the visualization title, description and access.
export interface IAnalyticalDesignerVisualizationInfoProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Remarks
The children come already rendered with their own slots. Render each of them at most once.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ReactNode | (ALPHA) The lock and unsaved changes indicators. | ||
boolean | (ALPHA) Whether a navigation request is refused now, because the visualization is being saved. | ||
() => void | (ALPHA) Requests leaving the editor, for a Back control. | ||
ReactNode | (ALPHA) The dashboards that use the visualization, when Analytical Designer shows them. | ||
ReactNode | (ALPHA) The visualization access (the VisualizationAccess slot). | ||
ReactNode | (ALPHA) The visualization description (the VisualizationDescription slot). | ||
ReactNode | (ALPHA) The visualization title (the VisualizationTitle slot). |
Property details
IAnalyticalDesignerVisualizationInfoProps.indicatorspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The lock and unsaved changes indicators.
indicators: ReactNode;
IAnalyticalDesignerVisualizationInfoProps.isNavigationDisabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether a navigation request is refused now, because the visualization is being saved.
isNavigationDisabled: boolean;
IAnalyticalDesignerVisualizationInfoProps.onRequestBackpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Requests leaving the editor, for a Back control.
onRequestBack: () => void;
Remarks
Starts the cancellation flow that IAnalyticalDesignerApi.requestCancellation() starts too: Analytical Designer asks for confirmation when there are unsaved changes and then emits the insightEditingCancelled event, on which the host navigates. Navigate only on that event. Unlike that command, the request is ignored while isNavigationDisabled is true.
IAnalyticalDesignerVisualizationInfoProps.usagespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The dashboards that use the visualization, when Analytical Designer shows them.
usages: ReactNode;
IAnalyticalDesignerVisualizationInfoProps.visualizationAccesspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization access (the VisualizationAccess slot).
visualizationAccess: ReactNode;
IAnalyticalDesignerVisualizationInfoProps.visualizationDescriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization description (the VisualizationDescription slot).
visualizationDescription: ReactNode;
IAnalyticalDesignerVisualizationInfoProps.visualizationTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization title (the VisualizationTitle slot).
visualizationTitle: ReactNode;