DashboardLayoutSectionRemovedPayload
Home > @gooddata/sdk-ui-dashboard > DashboardLayoutSectionRemovedPayload
DashboardLayoutSectionRemovedPayload 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 DashboardLayoutSectionRemoved event.
Signature:
export interface DashboardLayoutSectionRemovedPayload
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
eagerRemoval? | readonly | boolean | (BETA) (Optional) Indicates that the section was removed as part of eager removal of the section items. |
index | readonly | number | (BETA) Index where the section originally resided. |
path | readonly | ILayoutSectionPath | (BETA) Path where the section originally resided. |
section | readonly | ExtendedDashboardLayoutSection | (BETA) Section that was removed. Note: when the section is eagerly removed, it's items will be empty. |
stashIdentifier? | readonly | StashedDashboardItemsId | (BETA) (Optional) If the remove command indicated to stash the items for later reuse, then the stash identifier provided on the command is mirrored here. |