changeKpiWidgetConfiguration()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetConfiguration command. Dispatching this command will result is modification of the configuration that are effective for the particular kpi widget.
Through configuration, you can modify how is particular kpi rendered
If you want to clear any widget-level configuration, set config to undefined.
export declare function changeKpiWidgetConfiguration(ref: ObjRef, config: IKpiWidgetConfiguration | undefined, correlationId?: string): IChangeKpiWidgetConfiguration;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the insight widget to modify | |
config | IKpiWidgetConfiguration | undefined | new configuration to set, undefined to clear any widget level config |
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