IChangeKpiWidgetMeasurePayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IChangeKpiWidgetMeasure command.
export interface IChangeKpiWidgetMeasurePayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| IWidgetHeader | “from-measure” | (BETA) (Optional) Specify the new header that should be used for the KPI widget with the changed measure. | |
| (BETA) Reference to the new measure to use instead of the old measure. | ||
| (BETA) KPI Widget reference whose measure to change. |
Property details
IChangeKpiWidgetMeasurePayload.headerpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Specify the new header that should be used for the KPI widget with the changed measure.
readonly header?: IWidgetHeader | "from-measure";
Remarks
You may specify the widget header as ‘from-measure’. In that case the title will be automatically set to the title of measure specified in the measureRef property.
IChangeKpiWidgetMeasurePayload.measureRefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Reference to the new measure to use instead of the old measure.
readonly measureRef: ObjRef;
IChangeKpiWidgetMeasurePayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
KPI Widget reference whose measure to change.
readonly ref: ObjRef;