dashboardTabSwitched()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the DashboardTabSwitched event.
export declare function dashboardTabSwitched(ctx: DashboardContext, previousTabId: string | undefined, newTabId: string, correlationId?: string, source?: DashboardTabSwitchSource): IDashboardTabSwitched;
Parameters
Parameter | Type | Description |
|---|---|---|
ctx | 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 |
source | (Optional) what triggered the switch; omit for a regular user-initiated tab switch. See DashboardTabSwitchSource. |
Returns
dashboard tab switched event