changeKpiWidgetMeasure()

Home > @gooddata/sdk-ui-dashboard > changeKpiWidgetMeasure

changeKpiWidgetMeasure() 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 ChangeKpiWidgetMeasure command. Dispatching this command will result in change of the measure used by the KPI.

Signature:

export declare function changeKpiWidgetMeasure(ref: ObjRef, measureRef: ObjRef, header?: IWidgetHeader | "from-measure", correlationId?: string): IChangeKpiWidgetMeasure;

Parameters

Parameter	Type	Description
ref	ObjRef	reference of the KPI widget to modify
measureRef	ObjRef	reference of the measure to use
header	IWidgetHeader | "from-measure"	(Optional) specify new header to use; if not provided the existing header will be reused
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:

IChangeKpiWidgetMeasure