IAnalyticalDesignerSlots
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Regions of Analytical Designer that a host can replace or wrap.
export interface IAnalyticalDesignerSlots
Remarks
The editor header slots form a tree: EditorHeader holds VisualizationInfo and EditorActions, VisualizationInfo holds VisualizationTitle, VisualizationDescription and VisualizationAccess, and EditorActions holds UndoRedo, Clear, Open, Cancel, SaveAs, Save, Embed and Options. A slot can hide its region by returning null, replace it using the data and callbacks in defaultProps, or render Default with changed props or next to its own content. A region receives its children already rendered with their slots.
A control that Analytical Designer does not show, for its permissions, configuration (hiddenActions) or mode, does not render its slot. Hiding or changing a control grants no permission: the callbacks in defaultProps check again when called. Define slot components outside render, so that they keep their state.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
AnalyticalDesignerSlotComponent<IAnalyticalDesignerCancelProps> | (ALPHA) (Optional) The control that leaves the editor without saving, when Analytical Designer offers it. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerClearProps> | (ALPHA) (Optional) The control that clears the visualization. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerEditorActionsProps> | (ALPHA) (Optional) The controls on the right of the header. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerEditorHeaderProps> | (ALPHA) (Optional) The editor header, with the visualization information and the editor actions. Wrap the default to add content above or below it. Analytical Designer keeps the catalog restore control outside it. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerEmbedProps> | (ALPHA) (Optional) The control that embeds the visualization, including its menu. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerErrorProps> | (ALPHA) (Optional) Shown when Analytical Designer cannot start. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerLoadingProps> | (ALPHA) (Optional) Shown while Analytical Designer loads. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerOpenProps> | (ALPHA) (Optional) The control that opens a saved visualization, including its picker. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerOptionsProps> | (ALPHA) (Optional) The options menu with exports and the time zone, including its trigger. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerSaveProps> | (ALPHA) (Optional) The control that saves the visualization. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerSaveAsProps> | (ALPHA) (Optional) The control that saves the visualization as a new one, when Analytical Designer offers it. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerUndoRedoProps> | (ALPHA) (Optional) The undo and redo controls, as one control. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationAccessProps> | (ALPHA) (Optional) Who can open the visualization, including the sharing dialog. Rendered also where the built-in sharing is unavailable. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationDescriptionProps> | (ALPHA) (Optional) The visualization description, including its bubble. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationInfoProps> | (ALPHA) (Optional) The visualization title, description, access, indicators and dashboard usages. Wrap the default to add a Back control before the title. | ||
AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationTitleProps> | (ALPHA) (Optional) The visualization title. |
Property details
IAnalyticalDesignerSlots.CancelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that leaves the editor without saving, when Analytical Designer offers it.
Cancel?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerCancelProps>;
IAnalyticalDesignerSlots.ClearpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that clears the visualization.
Clear?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerClearProps>;
IAnalyticalDesignerSlots.EditorActionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The controls on the right of the header.
EditorActions?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerEditorActionsProps>;
IAnalyticalDesignerSlots.EditorHeaderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The editor header, with the visualization information and the editor actions. Wrap the default to add content above or below it. Analytical Designer keeps the catalog restore control outside it.
EditorHeader?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerEditorHeaderProps>;
IAnalyticalDesignerSlots.EmbedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that embeds the visualization, including its menu.
Embed?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerEmbedProps>;
IAnalyticalDesignerSlots.ErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Shown when Analytical Designer cannot start.
Error?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerErrorProps>;
IAnalyticalDesignerSlots.LoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Shown while Analytical Designer loads.
Loading?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerLoadingProps>;
IAnalyticalDesignerSlots.OpenpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that opens a saved visualization, including its picker.
Open?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerOpenProps>;
IAnalyticalDesignerSlots.OptionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The options menu with exports and the time zone, including its trigger.
Options?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerOptionsProps>;
IAnalyticalDesignerSlots.SavepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that saves the visualization.
Save?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerSaveProps>;
IAnalyticalDesignerSlots.SaveAspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The control that saves the visualization as a new one, when Analytical Designer offers it.
SaveAs?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerSaveAsProps>;
IAnalyticalDesignerSlots.UndoRedopropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The undo and redo controls, as one control.
UndoRedo?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerUndoRedoProps>;
IAnalyticalDesignerSlots.VisualizationAccesspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Who can open the visualization, including the sharing dialog. Rendered also where the built-in sharing is unavailable.
VisualizationAccess?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationAccessProps>;
IAnalyticalDesignerSlots.VisualizationDescriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization description, including its bubble.
VisualizationDescription?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationDescriptionProps>;
IAnalyticalDesignerSlots.VisualizationInfopropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization title, description, access, indicators and dashboard usages. Wrap the default to add a Back control before the title.
VisualizationInfo?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationInfoProps>;
IAnalyticalDesignerSlots.VisualizationTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The visualization title.
VisualizationTitle?: AnalyticalDesignerSlotComponent<IAnalyticalDesignerVisualizationTitleProps>;