moveSectionItemAndRemoveOriginalSectionIfEmpty()
Home > @gooddata/sdk-ui-dashboard > moveSectionItemAndRemoveOriginalSectionIfEmpty
moveSectionItemAndRemoveOriginalSectionIfEmpty() 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 MoveSectionItem command.
Signature:
export declare function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex: number, itemIndex: number, toSectionIndex: number, toItemIndex: number, correlationId?: string): MoveSectionItem;
Parameters
| Parameter | Type | Description |
|---|---|---|
| sectionIndex | number | source section index |
| itemIndex | number | index of item to move |
| toSectionIndex | number | target section index; you may specify -1 to move to last section |
| toItemIndex | number | index within target section where the item should be inserted; you may specify -1 to append |
| 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 TODO LX-648: Consider removing this command variant and leave only a nested variant |
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.
This command operates only on the root layout. For nested layouts, use moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty().