IRemoveLayoutSectionPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IRemoveLayoutSection command.
export interface IRemoveLayoutSectionPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) Index of section to remove. Zero based. For convenience -1 can be used to remove the last section. | ||
| (BETA) (Optional) Specify stash identifier. |
Property details
IRemoveLayoutSectionPayload.indexpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Index of section to remove.
Zero based. For convenience -1 can be used to remove the last section.
readonly index: RelativeIndex | ILayoutSectionPath;
Remarks
RelativeIndex support will be removed in the next major SDK version. Use ILayoutSectionPath instead.
TODO LX-648: Remove RelativeIndex type in the next major version.
IRemoveLayoutSectionPayload.stashIdentifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Specify stash identifier.
readonly stashIdentifier?: StashedDashboardItemsId;
Remarks
If provided, the items from the removed section will not be permanently removed but will be stored in the stash under this identifier. You can then use the stash identifier to ‘resurrect’ the items in different section.
Default behavior with no stashIdentifier is to also remove all items in the section.