IMoveLayoutSectionPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IMoveLayoutSection command.
export interface IMoveLayoutSectionPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| number | ILayoutSectionPath | (BETA) Index of the section to move. Index is zero-based. | |
| number | ILayoutSectionPath | (BETA) Index where the section should be moved. Index is zero-based. For convenience index of -1 means moving the item to the end of the section list. |
Property details
IMoveLayoutSectionPayload.sectionIndexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index of the section to move.
Index is zero-based.
readonly sectionIndex: number | ILayoutSectionPath;
Remarks
“number” support will be removed in the next major SDK version. Use ILayoutSectionPath instead.
TODO LX-648: Remove number type in the next major version.
IMoveLayoutSectionPayload.toIndexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Index where the section should be moved.
Index is zero-based. For convenience index of -1 means moving the item to the end of the section list.
readonly toIndex: number | ILayoutSectionPath;
Remarks
“number” support will be removed in the next major SDK version. Use ILayoutSectionPath instead.
TODO LX-648: Remove number type in the next major version.