ChangeInsightWidgetDescriptionPayload

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

ChangeInsightWidgetDescriptionPayload 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 ChangeInsightWidgetDescription command.

Signature:

export interface ChangeInsightWidgetDescriptionPayload 

Properties

Property	Modifiers	Type	Description
description	readonly	WidgetDescription	(BETA) Description to use for the Insight 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 Insight Widget whose description to change.