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

# ISwitchDashboardTabPayload

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- 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).
> 

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

**Signature:**

```typescript
export interface ISwitchDashboardTabPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [source?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iswitchdashboardtabpayload/index.md#iswitchdashboardtabpayloadsource) | `readonly` | [DashboardTabSwitchSource](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardtabswitchsource/index.md) | **_(ALPHA)_** _(Optional)_ What triggered this tab switch. |
| [tabId](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iswitchdashboardtabpayload/index.md#iswitchdashboardtabpayloadtabid) | `readonly` | string | **_(ALPHA)_** Identifier of the tab to switch to. |

## Property details

### ISwitchDashboardTabPayload.source

> **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).
> 

What triggered this tab switch.

**Signature:**

```typescript
readonly source?: DashboardTabSwitchSource;
```

#### Remarks

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) for the recognized values and their effect.

### ISwitchDashboardTabPayload.tabId

> **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).
> 

Identifier of the tab to switch to.

**Signature:**

```typescript
readonly tabId: string;
```