moveSectionItem()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the MoveSectionItem command.
export declare function moveSectionItem(sectionIndex: number, itemIndex: number, toSectionIndex: number, toItemIndex: number, correlationId?: string): IMoveSectionItem;
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.
This command operates only on the root layout. For nested layouts, use moveNestedLayoutSectionItem().