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

# IDashboardExportTabularOptions

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/dashboards/index.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).
> 

Options for exporting dashboard to tabular format.

**Signature:**

```typescript
export interface IDashboardExportTabularOptions extends IDashboardExportTimezoneOptions 
```
**Extends:** [IDashboardExportTimezoneOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttimezoneoptions/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dashboardFiltersOverride?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsdashboardfiltersoverride) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(ALPHA)_** _(Optional)_ If true, the dashboard filters will be applied to the exported dashboard |
| [dashboardTabsFiltersOverrides?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsdashboardtabsfiltersoverrides) |  | [FiltersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.filtersbytab/index.md) | **_(ALPHA)_** _(Optional)_ Override stored dashboard filters per tab with custom filters |
| [dashboardTabsParametersOverrides?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsdashboardtabsparametersoverrides) |  | Record<string, [IDashboardExportParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardexportparameter/index.md)[]> | **_(ALPHA)_** _(Optional)_ Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`. |
| [exportInfo?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsexportinfo) |  | boolean | **_(ALPHA)_** _(Optional)_ If true, the export info will be included in the file |
| [format?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsformat) |  | "XLSX" \| "PDF" | **_(ALPHA)_** _(Optional)_ Export format. Defaults to "XLSX" if not specified. |
| [mergeHeaders?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionsmergeheaders) |  | boolean | **_(ALPHA)_** _(Optional)_ If true, the headers will be merged into a single row |
| [pdfConfiguration?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionspdfconfiguration) |  | { pageSize?: "A3" \| "A4" \| "LETTER"; pageOrientation?: "PORTRAIT" \| "LANDSCAPE"; showInfoPage?: boolean; } | **_(ALPHA)_** _(Optional)_ PDF-specific configuration options. Only applicable when format is "PDF". |
| [timeout?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionstimeout) |  | number | **_(ALPHA)_** _(Optional)_ Override the default export result polling timeout (in milliseconds). |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionstitle) |  | string | **_(ALPHA)_** _(Optional)_ Title for the export. If not provided, the dashboard title will be fetched. |
| [widgetIds?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexporttabularoptions/index.md#idashboardexporttabularoptionswidgetids) |  | string[] | **_(ALPHA)_** _(Optional)_ Widgets to export. If not provided, all widgets will be exported. |

## Property details

### IDashboardExportTabularOptions.dashboardFiltersOverride

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

If true, the dashboard filters will be applied to the exported dashboard

**Signature:**

```typescript
dashboardFiltersOverride?: FilterContextItem[];
```

### IDashboardExportTabularOptions.dashboardTabsFiltersOverrides

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

Override stored dashboard filters per tab with custom filters

**Signature:**

```typescript
dashboardTabsFiltersOverrides?: FiltersByTab;
```

### IDashboardExportTabularOptions.dashboardTabsParametersOverrides

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

Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering for that tab's sub-export. Mirrors `dashboardTabsFiltersOverrides`.

**Signature:**

```typescript
dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;
```

### IDashboardExportTabularOptions.exportInfo

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

If true, the export info will be included in the file

**Signature:**

```typescript
exportInfo?: boolean;
```

### IDashboardExportTabularOptions.format

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

Export format. Defaults to "XLSX" if not specified.

**Signature:**

```typescript
format?: "XLSX" | "PDF";
```

### IDashboardExportTabularOptions.mergeHeaders

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

If true, the headers will be merged into a single row

**Signature:**

```typescript
mergeHeaders?: boolean;
```

### IDashboardExportTabularOptions.pdfConfiguration

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

PDF-specific configuration options. Only applicable when format is "PDF".

**Signature:**

```typescript
pdfConfiguration?: {
        pageSize?: "A3" | "A4" | "LETTER";
        pageOrientation?: "PORTRAIT" | "LANDSCAPE";
        showInfoPage?: boolean;
    };
```

### IDashboardExportTabularOptions.timeout

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

Override the default export result polling timeout (in milliseconds).

**Signature:**

```typescript
timeout?: number;
```

#### Remarks

If not specified, there is still a default timeout applied. You can use this to make the timeout more aggressive or more relaxed than the default. We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.

### IDashboardExportTabularOptions.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).
> 

Title for the export. If not provided, the dashboard title will be fetched.

**Signature:**

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

### IDashboardExportTabularOptions.widgetIds

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

Widgets to export. If not provided, all widgets will be exported.

**Signature:**

```typescript
widgetIds?: string[];
```