DashboardMetaState · GoodData.UI API reference

Home > @gooddata/sdk-ui-dashboard > DashboardMetaState

DashboardMetaState interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export interface DashboardMetaState

Properties

Property	Modifiers	Type	Description
descriptor?		DashboardDescriptor	*(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.
persistedDashboard?		IDashboard	*(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

Modifiers

Type

Description

descriptor?

DashboardDescriptor

(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.

persistedDashboard?

IDashboard

(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)