changeKpiWidgetHeader()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Creates the ChangeKpiWidgetHeader command. Dispatching this command will result in change of the KPI widget’s header which (now) includes title.
export declare function changeKpiWidgetHeader(ref: ObjRef, header: IWidgetHeader, correlationId?: string): IChangeKpiWidgetHeader;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference of the KPI widget to modify | |
header | new header 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