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

# IExportConfig

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/execution/index.ts

Configuration for exports of results into tabular formats.

**Signature:**

```typescript
export interface IExportConfig 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [additionalExecutions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigadditionalexecutions) |  | ReadonlyArray<[IExportAdditionalExecution](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportadditionalexecution/index.md)> | **_(ALPHA)_** _(Optional)_ Pre-executed additional layers for multi-layer geo visualizations. |
| [conditionalFormatting?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigconditionalformatting) |  | [IConditionalFormatting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iconditionalformatting/index.md) | **_(ALPHA)_** _(Optional)_ Conditional formatting rules to apply when generating the export. |
| [delimiter?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigdelimiter) |  | string | _(Optional)_ Applicable for CSV format; specifies the delimiter to use between values. |
| [format?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigformat) |  | "xlsx" \| "csv" \| "raw" \| "pdf" | _(Optional)_ Format of the export file. Defaults to CSV if not specified. |
| [grandTotalsPosition?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfiggrandtotalsposition) |  | "pinnedBottom" \| "pinnedTop" \| "bottom" \| "top" | _(Optional)_ Position of grand totals in the exported document. |
| [mergeHeaders?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigmergeheaders) |  | boolean | _(Optional)_ Applicable for XLSX format; indicates whether headers and cells in the sheet should be merged. |
| [pdfConfiguration?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigpdfconfiguration) |  | [IExportPdfConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportpdfconfig/index.md) | _(Optional)_ Applicable for PDF format; specifies configuration for PDF export. |
| [showFilters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigshowfilters) |  | boolean | _(Optional)_ Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in the Excel sheet. |
| [timeout?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigtimeout) |  | number | _(Optional)_ Override the default export result polling timeout (in milliseconds). |
| [timezoneId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigtimezoneid) |  | string | **_(ALPHA)_** _(Optional)_ Concrete IANA timezone ID used to resolve relative date filters and render date/time values in the export. Overrides the workspace/user timezone settings. |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigtitle) |  | string | _(Optional)_ Applicable for XLSX format; specifies title of the workbook. |
| [visualizationObjectCustomFilters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigvisualizationobjectcustomfilters) |  | Array<[IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)> | _(Optional)_ Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (PDF only) |
| [visualizationObjectId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportconfig/index.md#iexportconfigvisualizationobjectid) |  | string | _(Optional)_ Visualization object identifier. Used to ensure the export result is generated based on existing visualization in the PDF document. (PDF only) |

## Property details

### IExportConfig.additionalExecutions

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

Pre-executed additional layers for multi-layer geo visualizations.

**Signature:**

```typescript
additionalExecutions?: ReadonlyArray<IExportAdditionalExecution>;
```

#### Remarks

When set, the export includes one sheet (XLSX) or file (CSV zip) per layer. The result that [IExecutionResult.export()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutionresult/index.md#iexecutionresultexport) is called on is the main layer (index 0); these are the additional layers, in their original order. Each layer carries its own execution result so the backend can build per-layer overrides.

### IExportConfig.conditionalFormatting

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

Conditional formatting rules to apply when generating the export.

**Signature:**

```typescript
conditionalFormatting?: IConditionalFormatting;
```

#### Remarks

Sent as-is; when combined with `visualizationObjectId` this replaces that visualization's stored rules rather than merging with them.

### IExportConfig.delimiter

Applicable for CSV format; specifies the delimiter to use between values.

**Signature:**

```typescript
delimiter?: string;
```

### IExportConfig.format

Format of the export file. Defaults to CSV if not specified.

**Signature:**

```typescript
format?: "xlsx" | "csv" | "raw" | "pdf";
```

### IExportConfig.grandTotalsPosition

Position of grand totals in the exported document.

**Signature:**

```typescript
grandTotalsPosition?: "pinnedBottom" | "pinnedTop" | "bottom" | "top";
```

#### Remarks

Takes precedence over the position specified in the visualization object. Applicable to all tabular export formats (XLSX, CSV, PDF).

### IExportConfig.mergeHeaders

Applicable for XLSX format; indicates whether headers and cells in the sheet should be merged.

**Signature:**

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

### IExportConfig.pdfConfiguration

Applicable for PDF format; specifies configuration for PDF export.

**Signature:**

```typescript
pdfConfiguration?: IExportPdfConfig;
```

### IExportConfig.showFilters

Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in the Excel sheet.

**Signature:**

```typescript
showFilters?: boolean;
```

#### Remarks

Filters provided here are purely to paint a better context for the person looking at the exported file. They serve no other purpose and are merely serialized in the export in a human-readable form. The visualizationObjectId has to be provided to make this work for PDF format.

### IExportConfig.timeout

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.

### IExportConfig.timezoneId

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

Concrete IANA timezone ID used to resolve relative date filters and render date/time values in the export. Overrides the workspace/user timezone settings.

**Signature:**

```typescript
timezoneId?: string;
```

### IExportConfig.title

Applicable for XLSX format; specifies title of the workbook.

**Signature:**

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

### IExportConfig.visualizationObjectCustomFilters

Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (PDF only)

**Signature:**

```typescript
visualizationObjectCustomFilters?: Array<IFilter>;
```

### IExportConfig.visualizationObjectId

Visualization object identifier. Used to ensure the export result is generated based on existing visualization in the PDF document. (PDF only)

**Signature:**

```typescript
visualizationObjectId?: string;
```