removeNestedLayoutSection()

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

removeNestedLayoutSection() function

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

Creates the RemoveLayoutSection command.

Signature:

export declare function removeNestedLayoutSection(index: ILayoutSectionPath, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveLayoutSection;

Parameters

Parameter	Type	Description
index	ILayoutSectionPath	index of section to remove
stashIdentifier	StashedDashboardItemsId	(Optional) specify identifier to stash items under; if you do not specify this, then the dashboard items in the removed section will also 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

Returns:

RemoveLayoutSection

Remarks

Dispatching this command will result in removal of the entire dashboard section. You can optionally specify that the items in the section should not be physically removed but instead be stashed for later 'resurrection'.