moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty()
Home > @gooddata/sdk-ui-dashboard > moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty
moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty() 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 MoveSectionItemToNewSection command.
Signature:
export declare function moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(itemPath: ILayoutItemPath, toSection: ILayoutSectionPath, correlationId?: string): MoveSectionItemToNewSection;
Parameters
| Parameter | Type | Description |
|---|---|---|
| itemPath | ILayoutItemPath | source item index |
| toSection | ILayoutSectionPath | target section index; you may specify -1 to move to last 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
Dispatching this command will result in move of single item within section or from one section to another. If original section stays empty after move, then it will be removed.