toggleLayoutDirection()

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

toggleLayoutDirection() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the ToggleLayoutDirection command.

Signature:

export declare function toggleLayoutDirection(layoutPath: ILayoutItemPath | undefined, direction: IDashboardLayoutContainerDirection, correlationId?: string): ToggleLayoutDirection;

Parameters

Parameter	Type	Description
layoutPath	ILayoutItemPath | undefined	layout for which the direction will be changed.
direction	IDashboardLayoutContainerDirection	the new direction for the layout ('row' or 'column').
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:

ToggleLayoutDirection

Remarks

This command changes the direction of the dashboard layout.