DashboardState

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

DashboardState interface

Layout of the dashboard component's state. State modifications are always done using Command API. Reading from state must always be done using the Selectors API.

Accessing state props directly is dangerous practice. We reserve the rights to refactor and otherwise break the shape of the state at any time while keeping the Selectors and Command APIs stable.

Signature:

export interface DashboardState 

Properties

Property	Modifiers	Type	Description
accessibleDashboards		EntityState<IListedDashboard>	(BETA)
alerts		EntityState<IWidgetAlert>	(BETA)
attributeFilterConfigs		AttributeFilterConfigsState	(ALPHA)
automations		AutomationsState	(ALPHA)
backendCapabilities		BackendCapabilitiesState
catalog		CatalogState
config		ConfigState
dashboardPermissions		DashboardPermissionsState
dateFilterConfig		DateFilterConfigState	(BETA)
dateFilterConfigs		DateFilterConfigsState	(ALPHA)
drill		DrillState	(BETA)
drillTargets		EntityState<IDrillTargets>	(ALPHA)
entitlements		EntitlementsState	(BETA)
executed		ExecutedState
executionResults		EntityState<IExecutionResultEnvelope>	(BETA) Part of state where execution results of the individual widgets are stored.
filterContext		FilterContextState
filterViews		FilterViewsState
inaccessibleDashboards		EntityState<IInaccessibleDashboard>	(ALPHA)
insights		EntityState<IInsight>	(BETA)
layout		LayoutState	(ALPHA)
legacyDashboards		LegacyDashboardsState
listedDashboards		EntityState<IListedDashboard>	(BETA)
loading		LoadingState	(BETA)
meta		DashboardMetaState	(BETA)
notificationChannels		NotificationChannelsState	(ALPHA)
permissions		PermissionsState
renderMode		RenderModeState	(BETA) State controlling how exactly the dashboard is rendered.
saving		SavingState
ui		UiState	(BETA) Ui state controllable from the outside.
user		UserState
users		UsersState	(ALPHA)