eagerRemoveSectionItem()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the RemoveSectionItem configured to do eager remove of item.
export declare function eagerRemoveSectionItem(sectionIndex: number, itemIndex: number, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): IRemoveSectionItem;
Parameters
Parameter | Type | Description |
|---|---|---|
sectionIndex | number | index of section from which to remove the item |
itemIndex | number | index of item to remove |
stashIdentifier | (Optional) stash identifier to store the removed item under; if not specified the item will be removed | |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing TODO LX-648: Consider removing this command variant and leave only a nested variant |
Returns
Remarks
Dispatching this command will result in removal of the item from a section and if the section only contains that item then the whole section will be removed as well.
You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.
This command operates only on the root layout. For nested layouts, use eagerRemoveNestedLayoutSectionItem().