moveNestedLayoutSection()
Home > @gooddata/sdk-ui-dashboard > moveNestedLayoutSection
moveNestedLayoutSection() 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 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 moveNestedLayoutSection(sectionIndex: ILayoutSectionPath, toIndex: ILayoutSectionPath, correlationId?: string): MoveLayoutSection;
Parameters
Parameter | Type | Description |
---|---|---|
sectionIndex | ILayoutSectionPath | index of section to move |
toIndex | ILayoutSectionPath | 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: