IDashboardKpiWidgetMeasureChangedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IDashboardKpiWidgetMeasureChanged event.
export interface IDashboardKpiWidgetMeasureChangedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) (Optional) If a new header was also set while changing the measure, then the new header value is included here. | ||
| (BETA) New setup of KPI. Includes the measure used to calculate KPI and the comparison settings that are in effect. Note: the comparison may be ’none’ - meaning | ||
| (BETA) Metadata object describing the measure that is now used on the KPI. | ||
| (BETA) Reference to changed KPI Widget. |
Property details
IDashboardKpiWidgetMeasureChangedPayload.headerpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If a new header was also set while changing the measure, then the new header value is included here.
readonly header?: IWidgetHeader;
IDashboardKpiWidgetMeasureChangedPayload.kpiWidgetpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
New setup of KPI. Includes the measure used to calculate KPI and the comparison settings that are in effect.
Note: the comparison may be ’none’ - meaning
readonly kpiWidget: IKpiWidget;
IDashboardKpiWidgetMeasureChangedPayload.measurepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Metadata object describing the measure that is now used on the KPI.
readonly measure: IMeasureMetadataObject;
IDashboardKpiWidgetMeasureChangedPayload.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Reference to changed KPI Widget.
readonly ref: ObjRef;