DashboardKpiWidgetMeasureChangedPayload

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

DashboardKpiWidgetMeasureChangedPayload 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 DashboardKpiWidgetMeasureChanged event.

Signature:

export interface DashboardKpiWidgetMeasureChangedPayload 

Properties

Property	Modifiers	Type	Description
header?	readonly	WidgetHeader	(BETA) (Optional) If a new header was also set while changing the measure, then the new header value is included here.
kpiWidget	readonly	IKpiWidget	(BETA) New setup of KPI. Includes the measure used to calculate KPI and the comparison settings that are in effect. Note: the comparison may be 'none' - meaning
measure	readonly	IMeasureMetadataObject	(BETA) Metadata object describing the measure that is now used on the KPI.
ref	readonly	ObjRef	(BETA) Reference to changed KPI Widget.