DashboardLayoutSectionItemReplacedPayload · GoodData.UI API reference

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

DashboardLayoutSectionItemReplacedPayload 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 DashboardLayoutSectionItemReplaced event.

Signature:

export interface DashboardLayoutSectionItemReplacedPayload

Properties

Property	Modifiers	Type	Description
itemIndex	`readonly`	number	*(BETA)* Index of item within the section that was replaced.
items	`readonly`	ReadonlyArray<ExtendedDashboardItem>	*(BETA)* New item definition.
path	`readonly`	ILayoutItemPath	*(BETA)* Path of item that was replaced.
previousItem	`readonly`	ExtendedDashboardItem	*(BETA)* Item that was replaced
sectionIndex	`readonly`	number	*(BETA)* Index of section where the replacement happened.
stashIdentifier?	`readonly`	StashedDashboardItemsId	*(BETA)* (Optional) If the replacement specified to stash the old item, then the identifier of the stash is included here.