changeKpiWidgetDescription()
Home > @gooddata/sdk-ui-dashboard > changeKpiWidgetDescription
changeKpiWidgetDescription() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ChangeKpiWidgetDescription command. Dispatching this command will result in change of the Kpi widget's description.
Signature:
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: