IDashboardParameterEntry
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
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.
export interface IDashboardParameterEntry
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) | |||
ParameterValue | undefined | (ALPHA) Currently-applied value for the chip. | ||
(ALPHA) (Optional) Staged (not yet applied) value under the apply-all-at-once mode. Presence means the entry is dirty: staging a value equal to |
Property details
IDashboardParameterEntry.parameterpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
parameter: IDashboardParameter;
IDashboardParameterEntry.runtimeOverridepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
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.
runtimeOverride: ParameterValue | undefined;
IDashboardParameterEntry.workingOverridepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Staged (not yet applied) value under the apply-all-at-once mode. Presence means the entry is dirty: staging a value equal to runtimeOverride deletes the field instead of storing it, and every direct runtime write deletes it too. Executions read runtimeOverride only; “Apply All” folds this into runtimeOverride.
workingOverride?: ParameterValue;