IDashboardParameterEntry

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

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

Per-parameter state tracked by the dashboard store.

parameter is the persisted-shape entry (mutated only on Save / on load). runtimeOverride is session-ephemeral and tracks the chip's currently-applied value. The two are kept distinct so Cancel can discard a draft cleanly and so future Reset / view-mode flows can promote one to the other independently.

Signature:

export interface IDashboardParameterEntry 

Properties

Property	Modifiers	Type	Description
parameter		IDashboardParameter	(ALPHA)
runtimeOverride		number | undefined	(ALPHA) Currently-applied value for the chip. undefined means "use the workspace default" — used when the parameter has no persisted value and the workspace catalog is unresolved (gated off, failed, or missing for the ref). Such entries are skipped when building widget execution overrides so the backend keeps using the parameter's own default.