RemoveSectionItemPayload · GoodData.UI API reference

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

RemoveSectionItemPayload interface

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.

Payload of the RemoveSectionItem command.

Signature:

export interface RemoveSectionItemPayload

Properties

Property	Modifiers	Type	Description
eager?	`readonly`	boolean	*(BETA)* (Optional) Specify whether to eagerly remove the entire section if the item being removed was the only item in the section.
itemIndex	`readonly`	RelativeIndex	*(BETA)* Index of section item that should be moved.
itemPath?	`readonly`	ILayoutItemPath	*(BETA)* (Optional) Index where the item to remove is located.
sectionIndex	`readonly`	number	*(BETA)* Index of the section where the item to move is located.
stashIdentifier?	`readonly`	StashedDashboardItemsId	*(BETA)* (Optional) Specify stash identifier.