dashboardTabSwitched()

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

dashboardTabSwitched() 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 DashboardTabSwitched event.

Signature:

export declare function dashboardTabSwitched(ctx: DashboardContext, previousTabId: string | undefined, newTabId: string, correlationId?: string): IDashboardTabSwitched;

Parameters

Parameter	Type	Description
ctx	DashboardContext	dashboard context
previousTabId	string | undefined	identifier of the previously active tab
newTabId	string	identifier of the newly active tab
correlationId	string	(Optional) correlation id to use for this event

Returns:

IDashboardTabSwitched

dashboard tab switched event