addVisualizationToSwitcherWidgetContent()

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

addVisualizationToSwitcherWidgetContent() 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 AddVisualizationToSwitcherWidgetContent command. Dispatching this command will result in addition of visualization to switcher widget.

Signature:

export declare function addVisualizationToSwitcherWidgetContent(ref: ObjRef, visualization: IInsightWidget, insight: IInsight, sizeInfo: IVisualizationSizeInfo, correlationId?: string): AddVisualizationToVisualizationSwitcherWidgetContent;

Parameters

Parameter

Type

Description

ref

ObjRef

reference of the visualization switcher widget to modify

visualization

IInsightWidget

visualization to add

insight

IInsight

sizeInfo

IVisualizationSizeInfo

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:

AddVisualizationToVisualizationSwitcherWidgetContent

← AddSectionItemsPayloadAddVisualizationToVisualizationSwitcherWidgetContent →