eagerRemoveSectionItemByWidgetRef()
Home > @gooddata/sdk-ui-dashboard > eagerRemoveSectionItemByWidgetRef
eagerRemoveSectionItemByWidgetRef() function
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the RemoveSectionItemByWidgetRef configured to do eager remove of item.
Signature:
export declare function eagerRemoveSectionItemByWidgetRef(widgetRef: ObjRef, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveSectionItemByWidgetRef;
Parameters
| Parameter | Type | Description |
|---|---|---|
| widgetRef | ObjRef | widget reference of the item to remove; |
| stashIdentifier | StashedDashboardItemsId | (Optional) stash identifier to store the removed item under; if not specified the item will 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 item from a section and if the section only contains that item then the whole section will be removed as well.
You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.