IDashboardExportParameter
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Backend-neutral parameter value carried on a dashboard tabular export.
export interface IDashboardExportParameter
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Parameter identifier; drives AFM execution. Matches the workspace catalog parameter’s id. | ||
(ALPHA) (Optional) Parameter type tag; matches the workspace parameter definition’s | |||
string | (ALPHA) Display title rendered into the export’s info sheet. Presentation-only; not consumed by execution. | ||
string | (ALPHA) Value to apply for the parameter, encoded as a string. |
Property details
IDashboardExportParameter.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Parameter identifier; drives AFM execution. Matches the workspace catalog parameter’s id.
id: string;
IDashboardExportParameter.parameterTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Parameter type tag; matches the workspace parameter definition’s type. Absent on rows persisted before the tag existed — those are decoded as NUMBER.
parameterType?: ParameterType;
IDashboardExportParameter.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Display title rendered into the export’s info sheet. Presentation-only; not consumed by execution.
title: string;
IDashboardExportParameter.valuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Value to apply for the parameter, encoded as a string.
value: string;