IAnalyticalDesignerVisualizationTitleProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the visualization title.
export interface IAnalyticalDesignerVisualizationTitleProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) Whether the title can be changed. | ||
boolean | (ALPHA) Whether the visualization is locked, for example because it is inherited from a parent workspace. | ||
number | (ALPHA) Maximum length of the title. | ||
(title: string) => void | (ALPHA) Changes the title. Ignored when the title cannot be changed. | ||
string | (ALPHA) Text shown when the visualization has no title. |
Property details
IAnalyticalDesignerVisualizationTitleProps.isEditablepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the title can be changed.
isEditable: boolean;
IAnalyticalDesignerVisualizationTitleProps.isLockedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the visualization is locked, for example because it is inherited from a parent workspace.
isLocked: boolean;
IAnalyticalDesignerVisualizationTitleProps.maxLengthpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Maximum length of the title.
maxLength: number;
IAnalyticalDesignerVisualizationTitleProps.onTitleChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Changes the title. Ignored when the title cannot be changed.
onTitleChange: (title: string) => void;
IAnalyticalDesignerVisualizationTitleProps.placeholderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Text shown when the visualization has no title.
placeholder: string;