IMoveSectionItemToNewSectionPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IMoveSectionItemToNewSection command.
export interface IMoveSectionItemToNewSectionPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| number | (BETA) Index of section item that should be moved. Index is zero-based. | |
| (BETA) (Optional) Index where the item to move is located. TODO LX-648: make the prop required | ||
| boolean | (BETA) If true and original section stays empty after move, then it will be removed. | |
| number | (BETA) Index of the section where the item to move is located. Index is zero-based. | |
| (BETA) (Optional) Path of section that should be created and the item should be moved into. Index is zero-based. For convenience, you may specify -1 to move to last section. TODO LX-648: make the prop required | ||
| (BETA) Index of section to which should be created and the item should be moved into. Index is zero-based. For convenience you may specify -1 to move to last section. |
Property details
IMoveSectionItemToNewSectionPayload.itemIndexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index of section item that should be moved.
Index is zero-based.
readonly itemIndex: number;
Remarks
IMoveSectionItemToNewSectionPayload.itemIndex support will be removed in the next major SDK version. Use IMoveSectionItemToNewSectionPayload.itemPath instead.
TODO LX-648: Remove itemIndex in the next major version.
IMoveSectionItemToNewSectionPayload.itemPathpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index where the item to move is located.
TODO LX-648: make the prop required
readonly itemPath?: ILayoutItemPath;
IMoveSectionItemToNewSectionPayload.removeOriginalSectionIfEmptypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If true and original section stays empty after move, then it will be removed.
readonly removeOriginalSectionIfEmpty: boolean;
IMoveSectionItemToNewSectionPayload.sectionIndexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index of the section where the item to move is located.
Index is zero-based.
readonly sectionIndex: number;
Remarks
IMoveSectionItemToNewSectionPayload.sectionIndex support will be removed in the next major SDK version. Use IMoveSectionItemToNewSectionPayload.itemPath instead.
TODO LX-648: Remove sectionIndex in the next major version.
IMoveSectionItemToNewSectionPayload.toSectionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Path of section that should be created and the item should be moved into.
Index is zero-based. For convenience, you may specify -1 to move to last section.
TODO LX-648: make the prop required
readonly toSection?: ILayoutSectionPath;
IMoveSectionItemToNewSectionPayload.toSectionIndexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index of section to which should be created and the item should be moved into.
Index is zero-based. For convenience you may specify -1 to move to last section.
readonly toSectionIndex: RelativeIndex;
Remarks
IMoveSectionItemToNewSectionPayload.toSectionIndex support will be removed in the next major SDK version. Use IMoveSectionItemToNewSectionPayload.itemPath instead.
TODO LX-648: Remove toSectionIndex in the next major version.