MoveSectionItemPayload

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

MoveSectionItemPayload 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 MoveSectionItem command.

Signature:

export interface MoveSectionItemPayload 

Properties

Property	Modifiers	Type	Description
fromPath?	readonly	ILayoutItemPath	(BETA) (Optional) Path where the item to move is located. Index is zero-based. TODO LX-648: make the prop required
itemIndex	readonly	number	(BETA) Index of section item that should be moved. Index is zero-based.
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.
toItemIndex	readonly	RelativeIndex	(BETA) Index within the target section. Index is zero-based. For convenience you may specify -1 to append the item at the end of the target section's items.
toPath?	readonly	ILayoutItemPath	(BETA) (Optional) Path to which the item should be moved. 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 the item should be moved. Index is zero-based. For convenience you may specify -1 to move to last section.