IDashboardParameter
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard-level parameter override entry.
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 |
|---|---|---|---|
| string | (ALPHA) (Optional) Author-renamed label; absent when equal to the parameter’s title. | |
| (ALPHA) Visibility/interactivity mode. Absent value defaults to | ||
| (ALPHA) Type tag; matches the workspace parameter definition’s | ||
| (ALPHA) Reference to the workspace parameter metadata object. | ||
| (ALPHA) (Optional) Dashboard’s pinned override; absent when equal to the workspace default. |
Property details
IDashboardParameter.labelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Author-renamed label; absent when equal to the parameter’s title.
readonly label?: string;
IDashboardParameter.modepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Visibility/interactivity mode. Absent value defaults to "active".
readonly mode: DashboardParameterMode;
IDashboardParameter.parameterTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Type tag; matches the workspace parameter definition’s type.
readonly parameterType: ParameterType;
IDashboardParameter.refpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Reference to the workspace parameter metadata object.
readonly ref: IdentifierRef;
IDashboardParameter.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard’s pinned override; absent when equal to the workspace default.
readonly value?: ParameterValue;