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

# exportDashboardToExcel()

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: function
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/dashboard.ts
- Guides: [Customize dashboard export](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/customize-dashboard-export/index.md)

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Creates the [IExportDashboardToExcel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iexportdashboardtoexcel/index.md) command. Dispatching this command will result in a request to export the dashboard to a EXCEL file. If successful, an instance of [IDashboardExportToExcelResolved](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardexporttoexcelresolved/index.md) will be emitted with the URL of the resulting file.

**Signature:**

```typescript
export declare function exportDashboardToExcel(mergeHeaders: boolean, exportInfo: boolean, widgetIds?: string[], fileName?: string, format?: "XLSX" | "PDF", pdfConfiguration?: PdfConfiguration, correlationId?: string): IExportDashboardToExcel;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| mergeHeaders | boolean | if true, the headers will be merged into a single row |
| exportInfo | boolean | if true, the export info will be included in the EXCEL file |
| widgetIds | string[] | _(Optional)_ if provided, the widgets with the given ids will be exported |
| fileName | string | _(Optional)_ if provided, the file will be saved with the given name |
| format | "XLSX" \| "PDF" | _(Optional)_ |
| pdfConfiguration | [PdfConfiguration](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.pdfconfiguration/index.md) | _(Optional)_ |
| correlationId | string | _(Optional)_ specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |

**Returns:**

[IExportDashboardToExcel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iexportdashboardtoexcel/index.md)