ChangeKpiWidgetComparisonPayload · GoodData.UI API reference

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

ChangeKpiWidgetComparisonPayload 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 ChangeKpiWidgetComparison command.

Signature:

export interface ChangeKpiWidgetComparisonPayload

Properties

Property Modifiers Type Description

Property	Modifiers	Type	Description
comparison	`readonly`	KpiWidgetComparison	*(BETA)* Comparison settings to use for the KPI Widget. To disable comparison you can send empty object here.
ref	`readonly`	ObjRef	*(BETA)* Reference to KPI Widget whose filter settings to change.

comparison

readonly

KpiWidgetComparison

(BETA) Comparison settings to use for the KPI Widget.

To disable comparison you can send empty object here.

ref readonly ObjRef (BETA) Reference to KPI Widget whose filter settings to change.