IAnalyticalDesignerHeaderContext
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Data that every editor header slot receives.
export interface IAnalyticalDesignerHeaderContext
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) Whether the visualization differs from its last saved version, whether or not it can be saved now. A visualization that is not saved yet has changes once it is not blank. Always false in read-only mode. | ||
(ALPHA) (Optional) Reference of the saved visualization. Undefined for a visualization that is not saved yet. | |||
(ALPHA) Layout of the header. | |||
string | (ALPHA) Current title of the visualization. Empty for an untitled visualization. | ||
string | (ALPHA) Identifier of the workspace that Analytical Designer works in. |
Property details
IAnalyticalDesignerHeaderContext.hasUnsavedChangespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the visualization differs from its last saved version, whether or not it can be saved now. A visualization that is not saved yet has changes once it is not blank. Always false in read-only mode.
hasUnsavedChanges: boolean;
IAnalyticalDesignerHeaderContext.insightRefpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reference of the saved visualization. Undefined for a visualization that is not saved yet.
insightRef?: ObjRef;
IAnalyticalDesignerHeaderContext.layoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Layout of the header.
layout: IAnalyticalDesignerHeaderLayout;
IAnalyticalDesignerHeaderContext.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current title of the visualization. Empty for an untitled visualization.
title: string;
IAnalyticalDesignerHeaderContext.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Identifier of the workspace that Analytical Designer works in.
workspace: string;