removeSectionItem()

Home > @gooddata/sdk-ui-dashboard > removeSectionItem

removeSectionItem() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the RemoveSectionItem command.

Signature:

export declare function removeSectionItem(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	StashedDashboardItemsId	(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:

IRemoveSectionItem

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.

This command operates only on the root layout. For nested layouts, use removeNestedLayoutSectionItem().