removeLayoutSection()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Creates the RemoveLayoutSection command.
export declare function removeLayoutSection(index: number, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): IRemoveLayoutSection;
Parameters
Parameter | Type | Description |
|---|---|---|
index | number | index of section to remove |
stashIdentifier | (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
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’.
This command operates only on the root layout. For nested layouts, use removeNestedLayoutSection().