ChangeInsightWidgetVisPropertiesPayload · GoodData.UI API reference

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

ChangeInsightWidgetVisPropertiesPayload 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 ChangeInsightWidgetVisProperties command.

Signature:

export interface ChangeInsightWidgetVisPropertiesPayload

Properties

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

Property

Modifiers

Type

Description

properties

readonly

VisualizationProperties | undefined

(BETA) Visualization properties to use for the insight that is rendered by the widget.

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

ref

readonly

ObjRef

(BETA) Reference to Insight Widget whose visualization properties to change.