changeVisualizationSwitcherActiveVisualization()
Home > @gooddata/sdk-ui-dashboard > changeVisualizationSwitcherActiveVisualization
changeVisualizationSwitcherActiveVisualization() 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 ChangeVisualizationSwitcherActiveVisualization command. Dispatching this command will result in the change of the active visualization in the visualization switcher widget.
Signature:
export declare function changeVisualizationSwitcherActiveVisualization(ref: ObjRef, activeVisualizationIdentifier: string, correlationId?: string): IChangeVisualizationSwitcherActiveVisualization;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
ref |
reference of the visualization switcher widget to modify | |
|
activeVisualizationIdentifier |
string |
identifier of the active visualization |
|
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: