IMoveSectionItemPayload

IMoveSectionItemPayload.fromPathpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Path where the item to move is located.

Index is zero-based.

TODO LX-648: make the prop required

readonly fromPath?: ILayoutItemPath;

IMoveSectionItemPayload.itemIndexpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Index of section item that should be moved.

Index is zero-based.

readonly itemIndex: number;

Remarks

IMoveSectionItemPayload.itemIndex support will be removed in the next major SDK version. Use IMoveSectionItemPayload.fromPath instead.

TODO LX-648: Remove itemIndex in the next major version.

IMoveSectionItemPayload.removeOriginalSectionIfEmptypropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

If true and original section stays empty after move, then it will be removed.

readonly removeOriginalSectionIfEmpty: boolean;

IMoveSectionItemPayload.sectionIndexpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Index of the section where the item to move is located.

Index is zero-based.

readonly sectionIndex: number;

Remarks

IMoveSectionItemPayload.sectionIndex support will be removed in the next major SDK version. Use IMoveSectionItemPayload.fromPath instead.

TODO LX-648: Remove sectionIndex in the next major version.

IMoveSectionItemPayload.toItemIndexpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Index within the target section.

Index is zero-based. For convenience you may specify -1 to append the item at the end of the target section’s items.

readonly toItemIndex: RelativeIndex;

Remarks

IMoveSectionItemPayload.toItemIndex support will be removed in the next major SDK version. Use IMoveSectionItemPayload.toPath instead.

TODO LX-648: Remove toItemIndex in the next major version.

IMoveSectionItemPayload.toPathpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Path to which the item should be moved.

Index is zero-based. For convenience, you may specify -1 to move to last section.

TODO LX-648: make the prop required

readonly toPath?: ILayoutItemPath;

IMoveSectionItemPayload.toSectionIndexpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Index of section to which the item should be moved.

Index is zero-based. For convenience you may specify -1 to move to last section.

readonly toSectionIndex: RelativeIndex;

Remarks

IMoveSectionItemPayload.toSectionIndex support will be removed in the next major SDK version. Use IMoveSectionItemPayload.toPath instead.

TODO LX-648: Remove toSectionIndex in the next major version.