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

# ICreateDashboardTabPayload

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

**Signature:**

```typescript
export interface ICreateDashboardTabPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [index?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icreatedashboardtabpayload/index.md#icreatedashboardtabpayloadindex) | `readonly` | number | **_(ALPHA)_** _(Optional)_ Optional index at which the new tab should be inserted. Defaults to the end of the list. |
| [shouldStartRenaming?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icreatedashboardtabpayload/index.md#icreatedashboardtabpayloadshouldstartrenaming) | `readonly` | boolean | **_(ALPHA)_** _(Optional)_ Optional flag to indicate whether the new tab should be started in renaming mode. |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icreatedashboardtabpayload/index.md#icreatedashboardtabpayloadtitle) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Optional title for the new tab. If not provided, empty title will be used. |

## Property details

### ICreateDashboardTabPayload.index

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

Optional index at which the new tab should be inserted. Defaults to the end of the list.

**Signature:**

```typescript
readonly index?: number;
```

### ICreateDashboardTabPayload.shouldStartRenaming

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

Optional flag to indicate whether the new tab should be started in renaming mode.

**Signature:**

```typescript
readonly shouldStartRenaming?: boolean;
```

### ICreateDashboardTabPayload.title

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

Optional title for the new tab. If not provided, empty title will be used.

**Signature:**

```typescript
readonly title?: string;
```