switchDashboardTab()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the SwitchDashboardTab command.
export declare function switchDashboardTab(tabId: string, correlationId?: string, source?: DashboardTabSwitchSource): ISwitchDashboardTab;
Parameters
Parameter | Type | Description |
|---|---|---|
tabId | string | identifier of the tab to switch to |
correlationId | string | (Optional) specify correlation id to use for this command |
source | (Optional) what triggered the switch; omit for a regular user-initiated tab switch. See DashboardTabSwitchSource. |
Returns
switch dashboard tab command