IDashboardLayoutSectionItemRemovedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IDashboardLayoutSectionItemRemoved event.
export interface IDashboardLayoutSectionItemRemovedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (BETA) Item that was removed. | ||
| number | (BETA) Index where the item resided. | |
| (BETA) Path where the item resided. | ||
| (BETA) (Optional) If the removal was eager and removed the entire section, then that section is included here. NOTE: the IDashboardLayoutSectionRemoved will be fired at the occasion as well. | ||
| (BETA) (Optional) If the removal indicated to stash the item, then the stash identifier is mirrored here. |
Property details
IDashboardLayoutSectionItemRemovedPayload.itempropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Item that was removed.
readonly item: ExtendedDashboardItem;
IDashboardLayoutSectionItemRemovedPayload.itemIndexpropertyBetaDeprecated
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 IDashboardLayoutSectionItemRemovedPayload.itemPath instead.
TODO LX-648: Remove property in the next major version.
Index where the item resided.
readonly itemIndex: number;
IDashboardLayoutSectionItemRemovedPayload.itemPathpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Path where the item resided.
readonly itemPath: ILayoutItemPath;
IDashboardLayoutSectionItemRemovedPayload.sectionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If the removal was eager and removed the entire section, then that section is included here.
NOTE: the IDashboardLayoutSectionRemoved will be fired at the occasion as well.
readonly section?: ExtendedDashboardLayoutSection;
IDashboardLayoutSectionItemRemovedPayload.stashIdentifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If the removal indicated to stash the item, then the stash identifier is mirrored here.
readonly stashIdentifier?: StashedDashboardItemsId;