ChangeKpiWidgetMeasurePayload · GoodData.UI API reference

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

ChangeKpiWidgetMeasurePayload interface

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.

Payload of the ChangeKpiWidgetMeasure command.

Signature:

export interface ChangeKpiWidgetMeasurePayload

Properties

Property	Modifiers	Type	Description
header?	`readonly`	WidgetHeader \| "from-measure"	*(BETA)* (Optional) Specify the new header that should be used for the KPI widget with the changed measure.
measureRef	`readonly`	ObjRef	*(BETA)* Reference to the new measure to use instead of the old measure.
ref	`readonly`	ObjRef	*(BETA)* KPI Widget reference whose measure to change.