IDashboardLayoutSectionRemovedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IDashboardLayoutSectionRemoved event.
export interface IDashboardLayoutSectionRemovedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (BETA) (Optional) Indicates that the section was removed as part of eager removal of the section items. | |
| number | (BETA) Index where the section originally resided. | |
| (BETA) Path where the section originally resided. | ||
| (BETA) Section that was removed. Note: when the section is eagerly removed, it’s items will be empty. | ||
| (BETA) (Optional) If the remove command indicated to stash the items for later reuse, then the stash identifier provided on the command is mirrored here. |
Property details
IDashboardLayoutSectionRemovedPayload.eagerRemovalpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
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.
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.
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.
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.
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;