changeRenderMode()

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

changeRenderMode() 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 ChangeRenderMode command. Dispatching this command will result in change of the render mode of dashboard component

Signature:

export declare function changeRenderMode(renderMode: RenderMode, renderModeChangeOptions?: IRenderModeChangeOptions, correlationId?: string): IChangeRenderMode;

Parameters

Parameter	Type	Description
renderMode	RenderMode	render mode value
renderModeChangeOptions	IRenderModeChangeOptions	(Optional) options for render mode change
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:

IChangeRenderMode