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

# IDashboardExportPdfOptions

- 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 PDF format

**Signature:**

```typescript
export interface IDashboardExportPdfOptions 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 |
| --- | --- | --- | --- |
| [exportMetadata?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpdfoptions/index.md#idashboardexportpdfoptionsexportmetadata) |  | Record<string, string> | **_(ALPHA)_** _(Optional)_ Custom export metadata forwarded through the export flow. |
| [filename?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpdfoptions/index.md#idashboardexportpdfoptionsfilename) |  | string | **_(ALPHA)_** _(Optional)_ Filename for the export. If not provided, the dashboard title will be fetched. |
| [parametersByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpdfoptions/index.md#idashboardexportpdfoptionsparametersbytab) |  | 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 runtime-overrides applied when rendering the exported file. Keyed by tab `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options. |
| [timeout?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idashboardexportpdfoptions/index.md#idashboardexportpdfoptionstimeout) |  | number | **_(ALPHA)_** _(Optional)_ Override the default export result polling timeout (in milliseconds). |

## Property details

### IDashboardExportPdfOptions.exportMetadata

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

Custom export metadata forwarded through the export flow.

**Signature:**

```typescript
exportMetadata?: Record<string, string>;
```

### IDashboardExportPdfOptions.filename

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

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

**Signature:**

```typescript
filename?: string;
```

### IDashboardExportPdfOptions.parametersByTab

> **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 runtime-overrides applied when rendering the exported file. Keyed by tab `localIdentifier`. Mirrors `dashboardTabsParametersOverrides` on the tabular options.

**Signature:**

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

### IDashboardExportPdfOptions.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.