IDashboardParameter

Home > @gooddata/sdk-model > IDashboardParameter

IDashboardParameter 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-level parameter override entry.

Signature:

export interface IDashboardParameter 

Remarks

value, label, and mode are smart-persisted: each is omitted when equal to its default (workspace default for value, parameter title for label, "active" for mode).

Properties

Property	Modifiers	Type	Description
label?	readonly	string	(ALPHA) (Optional) Author-renamed label; absent when equal to the parameter's title.
mode	readonly	DashboardParameterMode	(ALPHA) Visibility/interactivity mode. Absent value defaults to "active".
parameterType	readonly	"NUMBER"	(ALPHA) Type tag; only "NUMBER" is supported in this slice.
ref	readonly	IdentifierRef	(ALPHA) Reference to the workspace parameter metadata object.
value?	readonly	number	(ALPHA) (Optional) Dashboard's pinned override; absent when equal to the workspace default.