removeSectionItemByWidgetRef()
Home > @gooddata/sdk-ui-dashboard > removeSectionItemByWidgetRef
removeSectionItemByWidgetRef() function
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.
Creates the RemoveSectionItemByWidgetRef command.
Signature:
export declare function removeSectionItemByWidgetRef(widgetRef: ObjRef, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): IRemoveSectionItemByWidgetRef;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
widgetRef |
widget reference of the item to remove; | |
|
stashIdentifier |
(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. If the removed item was last in the section, the section will be left on the layout and will contain no items.