IDashboardLayoutSectionItemsAddedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IDashboardLayoutSectionItemsAdded event.
export interface IDashboardLayoutSectionItemsAddedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| ReadonlyArray<ExtendedDashboardItem> | (BETA) Items that were inserted. | |
| (BETA) Path of the inserted item. | ||
| number | (BETA) Index of the section to which the items were added. | |
| number | (BETA) Index within the section at which the items were inserted. | |
| ReadonlyArray<StashedDashboardItemsId> | (BETA) (Optional) If the items from one or more stashes were added and the stashes were cleared, the list of stash identifiers will be included here. |
Property details
IDashboardLayoutSectionItemsAddedPayload.itemsAddedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Items that were inserted.
readonly itemsAdded: ReadonlyArray<ExtendedDashboardItem>;
IDashboardLayoutSectionItemsAddedPayload.pathpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Path of the inserted item.
readonly path: ILayoutItemPath;
IDashboardLayoutSectionItemsAddedPayload.sectionIndexpropertyBetaDeprecated
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 IDashboardLayoutSectionItemsAddedPayload.path instead.
TODO LX-648: Remove property in the next major version.
Index of the section to which the items were added.
readonly sectionIndex: number;
IDashboardLayoutSectionItemsAddedPayload.startIndexpropertyBetaDeprecated
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 IDashboardLayoutSectionItemsAddedPayload.path instead.
TODO LX-648: Remove property in the next major version.
Index within the section at which the items were inserted.
readonly startIndex: number;
IDashboardLayoutSectionItemsAddedPayload.stashesUsedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If the items from one or more stashes were added and the stashes were cleared, the list of stash identifiers will be included here.
readonly stashesUsed?: ReadonlyArray<StashedDashboardItemsId>;