changeInsightWidgetVisProperties()

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

changeInsightWidgetVisProperties() function

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.

Creates the ChangeInsightWidgetVisProperties command. Dispatching this command will result is modification of the visualization properties that are effective for the particular insight widget.

Through visualization properties, you can modify how particular visualization looks and behaves (enable/disable tooltips, legend, change axes, enable zooming).

If you want to clear any widget-level properties, set properties to undefined.

Signature:

export declare function changeInsightWidgetVisProperties(ref: ObjRef, properties: VisualizationProperties | undefined, correlationId?: string): IChangeInsightWidgetVisProperties;

Parameters

Parameter

Type

Description

ref

ObjRef

reference of the insight widget to modify

properties

VisualizationProperties | undefined

new properties to set, undefined to clear any widget level visualization properties

correlationId

string

(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

IChangeInsightWidgetVisProperties

← ChangeInsightWidgetVisConfigurationPayloadchangeKpiWidgetComparison() →