IDashboardMetaState
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
export interface IDashboardMetaState
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) This property contains current state of the dashboard’s descriptive metadata. This descriptor can be modified by the dashboard component and the new values will be used during save. | |||
boolean | (BETA) (Optional) This property indicates whether the dashboard is dynamically filled. This means that the dashboard is not loaded from existing persisted dashboard but is instead built from scratch based on the provided items. | ||
(BETA) (Optional) This property contains the IDashboard object that is persisted on the backend and that is used to derive the rest of the dashboard state in the component. The persisted dashboard is updated only during the initial load or during SaveDashboard or SaveAsDashboard command processing (which essentially flush the current dashboard state to backend) |
Property details
IDashboardMetaState.descriptorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
This property contains current state of the dashboard’s descriptive metadata. This descriptor can be modified by the dashboard component and the new values will be used during save.
descriptor?: DashboardDescriptor;
IDashboardMetaState.initialContentpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
This property indicates whether the dashboard is dynamically filled. This means that the dashboard is not loaded from existing persisted dashboard but is instead built from scratch based on the provided items.
initialContent?: boolean;
IDashboardMetaState.persistedDashboardpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
This property contains the IDashboard object that is persisted on the backend and that is used to derive the rest of the dashboard state in the component.
The persisted dashboard is updated only during the initial load or during SaveDashboard or SaveAsDashboard command processing (which essentially flush the current dashboard state to backend)
persistedDashboard?: IDashboard;