moveLayoutSection()
Home > @gooddata/sdk-ui-dashboard > moveLayoutSection
moveLayoutSection() 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 MoveLayoutSection command. Dispatching this command will result in move of the section located at sectionIndex to a new place indicated by toIndex.
Signature:
export declare function moveLayoutSection(sectionIndex: number, toIndex: number, correlationId?: string): IMoveLayoutSection;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
sectionIndex |
number |
index of section to move |
|
toIndex |
number |
the new index for the section |
|
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:
Remarks
This command operates only on the root layout. For nested layouts, use moveNestedLayoutSection().