IAnalyticalDesignerVisualizationDescriptionProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the visualization description.
export interface IAnalyticalDesignerVisualizationDescriptionProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Label of the action that adds a description. | ||
string | (ALPHA) Current description of the visualization. Empty when it has none. | ||
IFilter[] | (ALPHA) Filters of the visualization, which references in the rich text description resolve against. | ||
boolean | (ALPHA) Whether the description can be changed. | ||
(description: string) => void | (ALPHA) Changes the description. Ignored when the description cannot be changed. | ||
string | (ALPHA) Text shown in the empty description editor. | ||
(ALPHA) (Optional) Number separators for the references in the description. |
Property details
IAnalyticalDesignerVisualizationDescriptionProps.addLabelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label of the action that adds a description.
addLabel: string;
IAnalyticalDesignerVisualizationDescriptionProps.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current description of the visualization. Empty when it has none.
description: string;
IAnalyticalDesignerVisualizationDescriptionProps.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Filters of the visualization, which references in the rich text description resolve against.
filters: IFilter[];
IAnalyticalDesignerVisualizationDescriptionProps.isEditablepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the description can be changed.
isEditable: boolean;
IAnalyticalDesignerVisualizationDescriptionProps.onDescriptionChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Changes the description. Ignored when the description cannot be changed.
onDescriptionChange: (description: string) => void;
IAnalyticalDesignerVisualizationDescriptionProps.placeholderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Text shown in the empty description editor.
placeholder: string;
IAnalyticalDesignerVisualizationDescriptionProps.separatorspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Number separators for the references in the description.
separators?: ISeparators;