changeKpiWidgetDescription()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the ChangeKpiWidgetDescription command. Dispatching this command will result in change of the Kpi widget’s description.
export declare function changeKpiWidgetDescription(ref: ObjRef, description: IWidgetDescription, correlationId?: string): IChangeKpiWidgetDescription;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the kpi widget to modify | |
description | new description to use | |
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