ChangeKpiWidgetConfigurationPayload · GoodData.UI API reference

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

ChangeKpiWidgetConfigurationPayload 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 ChangeKpiWidgetConfiguration command.

Signature:

export interface ChangeKpiWidgetConfigurationPayload

Properties

Property	Modifiers	Type	Description
config	`readonly`	IKpiWidgetConfiguration \| undefined	*(BETA)* Configuration to use for the kpi that is rendered by the widget. These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to `undefined`.
ref	`readonly`	ObjRef	*(BETA)* Reference to Kpi Widget whose configuration to change.

Property

Modifiers

Type

Description

config

readonly

IKpiWidgetConfiguration | undefined

(BETA) Configuration to use for the kpi that is rendered by the widget.

These will replace the existing configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to undefined.

ref

readonly

ObjRef

(BETA) Reference to Kpi Widget whose configuration to change.