IDashboardDefinition

Home > @gooddata/sdk-model > IDashboardDefinition

IDashboardDefinition interface

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

Dashboard definition represents modified or created dashboard

Signature:

export interface IDashboardDefinition<TWidget = IDashboardWidget> extends IDashboardBase, IAccessControlAware, Partial<IDashboardObjectIdentity> 

Extends: IDashboardBase, IAccessControlAware, Partial<IDashboardObjectIdentity>

Properties

Property	Modifiers	Type	Description
activeTabId?	readonly	string	(ALPHA) (Optional) Identifier of the active tab for persistence purposes.
attributeFilterConfigs?	readonly	IDashboardAttributeFilterConfig[]	(ALPHA) (Optional) Dashboard extended attribute filter configs
dateFilterConfig?	readonly	IDashboardDateFilterConfig	(ALPHA) (Optional) Dashboard extended common date filter config
dateFilterConfigs?	readonly	IDashboardDateFilterConfigItem[]	(ALPHA) (Optional) Dashboard extended date filters with date data set/dimension configs
disableCrossFiltering?	readonly	boolean	(ALPHA) (Optional) Disables cross filtering for this dashboard.
disableFilterViews?	readonly	boolean	(ALPHA) (Optional) Disables listing and saving of filter views for this dashboard.
disableUserFilterReset?	readonly	boolean	(ALPHA) (Optional) Disables reset of user filters for this dashboard.
disableUserFilterSave?	readonly	boolean	(ALPHA) (Optional) Disables save of user filters for this dashboard.
evaluationFrequency?	readonly	string	(ALPHA) (Optional) Evaluation frequency of alerts for the dashboard.
filterContext?	readonly	IFilterContext | IFilterContextDefinition	(ALPHA) (Optional) Dashboard filter context, or temporary filter context
layout?	readonly	IDashboardLayout<TWidget>	(ALPHA) (Optional) The layout of the dashboard determines the dashboard widgets IWidget and where they are rendered
plugins?	readonly	IDashboardPluginLink[]	(ALPHA) (Optional) Plugins to use on this dashboard.
tabs?	readonly	IDashboardTab<TWidget>[]	(ALPHA) (Optional) Optional tabs configuration; when defined, the dashboard renders as a tabbed interface. Each tab has its own layout, filter context and filter configs.
type	readonly	"IDashboard"	(ALPHA)