toggleLayoutDirection()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates the ToggleLayoutDirection command.
export declare function toggleLayoutDirection(layoutPath: ILayoutItemPath | undefined, direction: IDashboardLayoutContainerDirection, correlationId?: string): IToggleLayoutDirection;
Parameters
Parameter | Type | Description |
|---|---|---|
layoutPath | ILayoutItemPath | undefined | layout for which the direction will be changed. |
direction | 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
IToggleLayoutDirection
Remarks
This command changes the direction of the dashboard layout.