IDashboardLayoutSectionRemovedPayload

IDashboardLayoutSectionRemovedPayload.eagerRemovalpropertyBeta

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

Indicates that the section was removed as part of eager removal of the section items.

readonly eagerRemoval?: boolean;

IDashboardLayoutSectionRemovedPayload.indexpropertyBetaDeprecated

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

Warning: This API is now obsolete.

The prop will be removed in the next major SDK version. Use IDashboardLayoutSectionRemovedPayload.path instead.

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

Index where the section originally resided.

readonly index: number;

IDashboardLayoutSectionRemovedPayload.pathpropertyBeta

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

Path where the section originally resided.

readonly path: ILayoutSectionPath;

IDashboardLayoutSectionRemovedPayload.sectionpropertyBeta

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

Section that was removed.

Note: when the section is eagerly removed, it’s items will be empty.

readonly section: ExtendedDashboardLayoutSection;

IDashboardLayoutSectionRemovedPayload.stashIdentifierpropertyBeta

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

If the remove command indicated to stash the items for later reuse, then the stash identifier provided on the command is mirrored here.

readonly stashIdentifier?: StashedDashboardItemsId;