changeKpiWidgetComparison()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetComparison command. Dispatching this command will result in change of what comparison method - if any - is used for the KPI’s Measure. The KPI may compare measure value from current period (as selected by the date filter) to previous period and then depending on whether the current value grows can visualize that as a good or bad thing.
export declare function changeKpiWidgetComparison(ref: ObjRef, comparison: IKpiWidgetComparison, correlationId?: string): IChangeKpiWidgetComparison;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
comparison | new comparison setting | |
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