IRemoveSectionItemPayload

IRemoveSectionItemPayload.eagerpropertyBeta

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

Specify whether to eagerly remove the entire section if the item being removed was the only item in the section.

readonly eager?: boolean;

Remarks

Default is false. Meaning an empty section will be left.

IRemoveSectionItemPayload.itemIndexpropertyBeta

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

Index of section item that should be moved.

readonly itemIndex: RelativeIndex;

Remarks

Index is zero-based. For convenience you may use index of -1 to remove last item from section.

IRemoveSectionItemPayload.itemIndex support will be removed in the next major SDK version. Use IRemoveSectionItemPayload.itemPath instead.

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

IRemoveSectionItemPayload.itemPathpropertyBeta

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

Index where the item to remove is located.

readonly itemPath?: ILayoutItemPath;

Remarks

Index is zero-based.

TODO LX-648: make the prop required

IRemoveSectionItemPayload.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.

readonly sectionIndex: number;

Remarks

Index is zero-based.

IRemoveSectionItemPayload.sectionIndex support will be removed in the next major SDK version. Use IRemoveSectionItemPayload.itemPath instead.

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

IRemoveSectionItemPayload.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 item 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 item in different section.

Default behavior with no stashIdentifier is to permanently remove the item as well.