IDashboardLayoutSectionItemReplacedPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Payload of the IDashboardLayoutSectionItemReplaced event.
export interface IDashboardLayoutSectionItemReplacedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| number | (BETA) Index of item within the section that was replaced. | |
| ReadonlyArray<ExtendedDashboardItem> | (BETA) New item definition. | |
| (BETA) Path of item that was replaced. | ||
| (BETA) Item that was replaced | ||
| number | (BETA) Index of section where the replacement happened. | |
| (BETA) (Optional) If the replacement specified to stash the old item, then the identifier of the stash is included here. |
Property details
IDashboardLayoutSectionItemReplacedPayload.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 IDashboardLayoutSectionItemReplacedPayload.path instead.
TODO LX-648: Remove property in the next major version.
Index of item within the section that was replaced.
readonly itemIndex: number;
IDashboardLayoutSectionItemReplacedPayload.itemspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
New item definition.
readonly items: ReadonlyArray<ExtendedDashboardItem>;
IDashboardLayoutSectionItemReplacedPayload.pathpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Path of item that was replaced.
readonly path: ILayoutItemPath;
IDashboardLayoutSectionItemReplacedPayload.previousItempropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Item that was replaced
readonly previousItem: ExtendedDashboardItem;
IDashboardLayoutSectionItemReplacedPayload.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 IDashboardLayoutSectionItemReplacedPayload.path instead.
TODO LX-648: Remove property in the next major version.
Index of section where the replacement happened.
readonly sectionIndex: number;
IDashboardLayoutSectionItemReplacedPayload.stashIdentifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
If the replacement specified to stash the old item, then the identifier of the stash is included here.
readonly stashIdentifier?: StashedDashboardItemsId;