MoveSectionItemToNewSectionPayload

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

MoveSectionItemToNewSectionPayload 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 MoveSectionItemToNewSection command.

Signature:

export interface MoveSectionItemToNewSectionPayload 

Properties

Property	Modifiers	Type	Description
itemIndex	readonly	number	(BETA) Index of section item that should be moved. Index is zero-based.
itemPath?	readonly	ILayoutItemPath	(BETA) (Optional) Index where the item to move is located. TODO LX-648: make the prop required
removeOriginalSectionIfEmpty	readonly	boolean	(BETA) If true and original section stays empty after move, then it will be removed.
sectionIndex	readonly	number	(BETA) Index of the section where the item to move is located. Index is zero-based.
toSection?	readonly	ILayoutSectionPath	(BETA) (Optional) Path of section that should be created and the item should be moved into. Index is zero-based. For convenience, you may specify -1 to move to last section. TODO LX-648: make the prop required
toSectionIndex	readonly	RelativeIndex	(BETA) Index of section to which should be created and the item should be moved into. Index is zero-based. For convenience you may specify -1 to move to last section.