dashboardTabDeleted()

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

dashboardTabDeleted() 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 DashboardTabDeleted event.

Signature:

export declare function dashboardTabDeleted(ctx: DashboardContext, deletedTabId: string, previousIndex: number, nextActiveTabId?: string, correlationId?: string): IDashboardTabDeleted;

Parameters

Parameter	Type	Description
ctx	DashboardContext	dashboard context
deletedTabId	string	identifier of the deleted tab
previousIndex	number	index from which the tab was deleted
nextActiveTabId	string	(Optional) identifier of the next active tab, if any
correlationId	string	(Optional) correlation id to use for this event

Returns:

IDashboardTabDeleted

dashboard tab deleted event