removeNestedLayoutSectionItem()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates the RemoveSectionItem command.
export declare function removeNestedLayoutSectionItem(itemPath: ILayoutItemPath, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): IRemoveSectionItem;
Parameters
Parameter | Type | Description |
|---|---|---|
itemPath | index from which to remove the item | |
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 |
Returns
Remarks
Dispatching this command will result in removal of the item from a section. If the removed item was last in the section, the section will be left on the layout and will contain no items.
You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.