IAnalyticalDesignerOpenProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the control that opens a saved visualization, including its picker.
export interface IAnalyticalDesignerOpenProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string[] | (ALPHA) Visualization class URLs Analytical Designer can edit. Other visualizations are shown as unknown. | ||
string[] | (ALPHA) (Optional) Visualizations with one of these tags are not offered. | ||
string[] | (ALPHA) (Optional) Only visualizations with one of these tags are offered. Undefined offers all. | ||
boolean | (ALPHA) Whether a visualization cannot be opened now, because one is being saved or opened. | ||
boolean | (ALPHA) Whether a visualization is being opened. | ||
boolean | (ALPHA) Whether the picker searches semantically too. | ||
string | (ALPHA) Label of the control. | ||
(ref: ObjRef) => void | (ALPHA) Opens a saved visualization. | ||
(ALPHA) How the default offers the visualizations. | |||
string | (ALPHA) (Optional) Identifier of the visualization that is open. Undefined for a visualization that is not saved yet. |
Property details
IAnalyticalDesignerOpenProps.enabledVisualizationUrlspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Visualization class URLs Analytical Designer can edit. Other visualizations are shown as unknown.
enabledVisualizationUrls: string[];
IAnalyticalDesignerOpenProps.excludeTagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Visualizations with one of these tags are not offered.
excludeTags?: string[];
IAnalyticalDesignerOpenProps.includeTagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Only visualizations with one of these tags are offered. Undefined offers all.
includeTags?: string[];
IAnalyticalDesignerOpenProps.isDisabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether a visualization cannot be opened now, because one is being saved or opened.
isDisabled: boolean;
IAnalyticalDesignerOpenProps.isLoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether a visualization is being opened.
isLoading: boolean;
IAnalyticalDesignerOpenProps.isSemanticSearchEnabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the picker searches semantically too.
isSemanticSearchEnabled: boolean;
IAnalyticalDesignerOpenProps.labelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label of the control.
label: string;
IAnalyticalDesignerOpenProps.onOpenInsightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Opens a saved visualization.
onOpenInsight: (ref: ObjRef) => void;
Remarks
Analytical Designer asks for confirmation when the current visualization has unsaved changes. The call requests the opening; the insightOpened event reports it. Ignored while isDisabled is true.
IAnalyticalDesignerOpenProps.pickerVariantpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
How the default offers the visualizations.
pickerVariant: AnalyticalDesignerInsightPickerVariant;
IAnalyticalDesignerOpenProps.selectedInsightIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Identifier of the visualization that is open. Undefined for a visualization that is not saved yet.
selectedInsightId?: string;