ChangeInsightWidgetVisConfigurationPayload · GoodData.UI API reference

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

ChangeInsightWidgetVisConfigurationPayload interface

Payload of the ChangeInsightWidgetVisConfiguration command.

Signature:

export interface ChangeInsightWidgetVisConfigurationPayload

Properties

Property	Modifiers	Type	Description
config	`readonly`	IInsightWidgetConfiguration \| undefined	Visualization configuration to use for the insight that is rendered by the widget. These will replace the existing visualization configuration. To clear any widget-level configuration currently in effect for the widget, set the configuration to `undefined`.
ref	`readonly`	ObjRef	Reference to Insight Widget whose visualization configuration to change.

Property

Modifiers

Type

Description

config

readonly

IInsightWidgetConfiguration | undefined

Visualization configuration to use for the insight that is rendered by the widget.

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

ref

readonly

ObjRef

Reference to Insight Widget whose visualization configuration to change.