> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# switchDashboardTab()

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: function
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/tabs.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates the SwitchDashboardTab command.

**Signature:**

```typescript
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 | [DashboardTabSwitchSource](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardtabswitchsource/index.md) | _(Optional)_ what triggered the switch; omit for a regular user-initiated tab switch. See [DashboardTabSwitchSource](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardtabswitchsource/index.md). |

**Returns:**

[ISwitchDashboardTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iswitchdashboardtab/index.md)

switch dashboard tab command