moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty()
Home > @gooddata/sdk-ui-dashboard > moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty
moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty() 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 MoveSectionItem command.
Signature:
export declare function moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty(fromPath: ILayoutItemPath, toPath: ILayoutItemPath, correlationId?: string): MoveSectionItem;
Parameters
| Parameter | Type | Description |
|---|---|---|
| fromPath | ILayoutItemPath | source item path |
| toPath | ILayoutItemPath | target path; you may specify -1 to move to last section/to be last item |
| 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.