changeKpiWidgetMeasure()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetMeasure command. Dispatching this command will result in change of the measure used by the KPI.
export declare function changeKpiWidgetMeasure(ref: ObjRef, measureRef: ObjRef, header?: IWidgetHeader | "from-measure", correlationId?: string): IChangeKpiWidgetMeasure;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
measureRef | reference of the measure to use | |
header | IWidgetHeader | “from-measure” | (Optional) specify new header to use; if not provided the existing header will be reused |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns