ChangeKpiWidgetDescriptionPayload · GoodData.UI API reference

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

ChangeKpiWidgetDescriptionPayload 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 ChangeKpiWidgetDescription command.

Signature:

export interface ChangeKpiWidgetDescriptionPayload

Properties

Property	Modifiers	Type	Description
description	`readonly`	WidgetDescription	*(BETA)* Description to use for the Kpi widget. Contents of the provided description will be used as-is and will be used to replace the current description values.
ref	`readonly`	ObjRef	*(BETA)* Reference to Kpi whose description to change.