---
product: "AG Grid"
title: "Excel Export API Reference"
description: "This page documents the Excel Export API and Interfaces."
enterprise: true
framework: vue
version: "36.2.0"
related:
    - title: "Styles"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-styles/"
    - title: "Formulas"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-formulas/"
    - title: "Extra Content"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-extra-content/"
    - title: "Notes"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-notes/"
    - title: "Customising Content"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-customising-content/"
    - title: "Images"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-images/"
    - title: "Excel Tables"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-tables/"
    - title: "Multiple Sheets"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-multiple-sheets/"
    - title: "Rows"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-rows/"
    - title: "Columns"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-columns/"
    - title: "Freezing Content"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-freeze/"
    - title: "Data Types"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-data-types/"
    - title: "Hyperlinks"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-hyperlinks/"
    - title: "Master Detail"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-master-detail/"
    - title: "Page Setup"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-page-setup/"
    - title: "Data Protection"
      url: "https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-data-protection/"
llms: "https://www.ag-grid.com/archive/36.2.0/llms.txt"
---

# Excel Export API Reference

This page documents the Excel Export API and Interfaces.

### Grid Properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `defaultExcelExportParams` | `ExcelExportParams` |  |  |  |
| `suppressExcelExport` | `boolean` |  |  |  |
| `excelStyles` | `ExcelStyle[]` |  |  |  |

### API Methods

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `exportDataAsExcel` | `Function` |  |  |  |
| `getDataAsExcel` | `Function` |  |  |  |
| `getSheetDataForExcel` | `Function` |  |  |  |
| `exportMultipleSheetsAsExcel` | `Function` |  |  |  |
| `getMultipleSheetsAsExcel` | `Function` |  |  |  |

## Interfaces

### ExcelExportParams

Properties available on the `ExcelExportParams` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `addImageToCell` | `Function` |  |  |  |
| `allColumns` | `boolean` |  |  |  |
| `appendContent` | `ExcelRow[]` |  |  |  |
| `author` | `string` |  |  |  |
| `autoConvertFormulas` | `boolean` |  |  |  |
| `columnKeys` | `(string \| Column)[]` |  |  |  |
| `columnWidth` | `number \| ((params: ColumnWidthCallbackParams) => number)` |  |  |  |
| `customMetadata` | `ExcelCustomMetadata` |  |  |  |
| `exportAsExcelTable` | `boolean \| ExcelTableConfig` |  |  |  |
| `exportRowNumbers` | `boolean` |  |  |  |
| `exportedRows` | `'all' \| 'filteredAndSorted'` |  |  |  |
| `fileName` | `string \| ExportFileNameGetter` |  |  |  |
| `fontSize` | `number` |  |  |  |
| `freezeColumns` | `'pinned' \| ExcelFreezeColumnsGetter` |  |  |  |
| `freezeRows` | `'headers' \| 'headersAndPinnedRows' \| ExcelFreezeRowsGetter` |  |  |  |
| `getCustomContentBelowRow` | `Function` |  |  |  |
| `headerFooterConfig` | `ExcelHeaderFooterConfig` |  |  |  |
| `headerRowHeight` | `number \| ((params: RowHeightCallbackParams) => number)` |  |  |  |
| `margins` | `ExcelSheetMargin` |  |  |  |
| `mimeType` | `string` |  |  |  |
| `onlySelected` | `boolean` |  |  |  |
| `onlySelectedAllPages` | `boolean` |  |  |  |
| `pageSetup` | `ExcelSheetPageSetup` |  |  |  |
| `prependContent` | `ExcelRow[]` |  |  |  |
| `processCellCallback` | `Function` |  |  |  |
| `processGroupHeaderCallback` | `Function` |  |  |  |
| `processHeaderCallback` | `Function` |  |  |  |
| `processNoteCallback` | `Function` |  |  |  |
| `processRowGroupCallback` | `Function` |  |  |  |
| `protectSheet` | `boolean \| ExcelSheetProtection` |  |  |  |
| `rightToLeft` | `boolean` |  |  |  |
| `rowGroupExpandState` | `'expanded' \| 'collapsed' \| 'match'` |  |  |  |
| `rowHeight` | `number \| ((params: RowHeightCallbackParams) => number)` |  |  |  |
| `rowPositions` | `RowPosition[]` |  |  |  |
| `sheetName` | `string \| ExcelSheetNameGetter` |  |  |  |
| `shouldRowBeSkipped` | `Function` |  |  |  |
| `skipColumnGroupHeaders` | `boolean` |  |  |  |
| `skipColumnHeaders` | `boolean` |  |  |  |
| `skipPinnedBottom` | `boolean` |  |  |  |
| `skipPinnedRowDuplicates` | `boolean` |  |  |  |
| `skipPinnedTop` | `boolean` |  |  |  |
| `skipRowGroups` | `boolean` |  |  |  |
| `suppressColumnOutline` | `boolean` |  |  |  |
| `suppressGridNotesExport` | `boolean` |  |  |  |
| `suppressPrependAuthorToNotes` | `boolean` |  |  |  |
| `suppressRowOutline` | `boolean` |  |  |  |
| `transformValues` | `boolean` |  |  |  |
| `valueFrom` | `CellValueResolveFrom` |  |  |  |

### ExcelExportMultipleSheetParams

Properties available on the `ExcelExportMultipleSheetParams` interface.

See [Multiple Sheets](https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-multiple-sheets/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `data` | `string[]` |  |  |  |
| `activeSheetIndex` | `number` |  |  |  |
| `fileName` | `string \| ExportFileNameGetter` |  |  |  |
| `author` | `string` |  |  |  |
| `suppressPrependAuthorToNotes` | `boolean` |  |  |  |
| `fontSize` | `number` |  |  |  |
| `mimeType` | `string` |  |  |  |
| `customMetadata` | `ExcelCustomMetadata` |  |  |  |

### ExcelAlignment

Properties available on the `ExcelAlignment` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `horizontal` | `\| 'Automatic'         \| 'Left'         \| 'Center'         \| 'Right'         \| 'Fill'         \| 'Justify'         \| 'CenterAcrossSelection'         \| 'Distributed'         \| 'JustifyDistributed'` |  |  |  |
| `indent` | `number` |  |  |  |
| `readingOrder` | `'RightToLeft' \| 'LeftToRight' \| 'Context'` |  |  |  |
| `rotate` | `number` |  |  |  |
| `shrinkToFit` | `boolean` |  |  |  |
| `vertical` | `'Automatic' \| 'Top' \| 'Bottom' \| 'Center' \| 'Justify' \| 'Distributed' \| 'JustifyDistributed'` |  |  |  |
| `wrapText` | `boolean` |  |  |  |

### ExcelBorders

Properties available on the `ExcelBorders` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `borderBottom` | `ExcelBorder` |  |  |  |
| `borderLeft` | `ExcelBorder` |  |  |  |
| `borderRight` | `ExcelBorder` |  |  |  |
| `borderTop` | `ExcelBorder` |  |  |  |

### ExcelBorder

Properties available on the `ExcelBorder` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `color` | `string` |  |  |  |
| `lineStyle` | `'None' \| 'Continuous' \| 'Dash' \| 'Dot' \| 'DashDot' \| 'DashDotDot' \| 'SlantDashDot' \| 'Double'` |  |  |  |
| `weight` | `0 \| 1 \| 2 \| 3` |  |  |  |

### ExcelCell

Properties available on the `ExcelCell` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `data` | `ExcelData` |  |  |  |
| `ref` | `string` |  |  |  |
| `collapsibleRanges` | `number[][]` |  |  |  |
| `styleId` | `string \| string[]` |  |  |  |
| `mergeAcross` | `number` |  |  |  |
| `note` | `ExcelNote` |  |  |  |

### ExcelNote

Properties available on the `ExcelNote` interface.

See [Notes](https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-notes/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `text` | `string` |  |  |  |
| `author` | `string` |  |  |  |

### ExcelData

Properties available on the `ExcelData` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `type` | `ExcelDataType \| ExcelOOXMLDataType` |  |  |  |
| `value` | `string \| null` |  |  |  |

### ExcelFont

Properties available on the `ExcelFont` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `bold` | `boolean` |  |  |  |
| `color` | `string` |  |  |  |
| `family` | `string` |  |  |  |
| `fontName` | `string` |  |  |  |
| `italic` | `boolean` |  |  |  |
| `outline` | `boolean` |  |  |  |
| `shadow` | `boolean` |  |  |  |
| `size` | `number` |  |  |  |
| `strikeThrough` | `boolean` |  |  |  |
| `underline` | `'Single' \| 'Double'` |  |  |  |
| `verticalAlign` | `'Superscript' \| 'Subscript'` |  |  |  |

### ExcelHeaderFooterConfig

Properties available on the `ExcelHeaderFooterConfig` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `all` | `ExcelHeaderFooter` |  |  |  |
| `first` | `ExcelHeaderFooter` |  |  |  |
| `even` | `ExcelHeaderFooter` |  |  |  |

### ExcelHeaderFooter

Properties available on the `ExcelHeaderFooter` interface. At least one of header or footer is required or both.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `header` | `ExcelHeaderFooterContent[]` |  |  |  |
| `footer` | `ExcelHeaderFooterContent[]` |  |  |  |

### ExcelHeaderFooterContent

Properties available on the `ExcelHeaderFooterContent` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `value` | `string` |  |  |  |
| `image` | `ExcelHeaderFooterImage` |  |  |  |
| `position` | `'Left' \| 'Center' \| 'Right'` |  |  |  |
| `font` | `ExcelFont` |  |  |  |

### ExcelHeaderFooterImage

Properties available on the `ExcelHeaderFooterImage` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `width` | `number` |  |  |  |
| `height` | `number` |  |  |  |
| `id` | `string` |  |  |  |
| `base64` | `string` |  |  |  |
| `imageType` | `'jpg' \| 'png' \| 'gif'` |  |  |  |
| `recolor` | `'Grayscale' \| 'Black & White' \| 'Washout'` |  |  |  |
| `brightness` | `number` |  |  |  |
| `contrast` | `number` |  |  |  |
| `altText` | `string` |  |  |  |

### ExcelImage

Properties available on the `ExcelImage` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `id` | `string` |  |  |  |
| `base64` | `string` |  |  |  |
| `imageType` | `'jpg' \| 'png' \| 'gif'` |  |  |  |
| `fitCell` | `boolean` |  |  |  |
| `transparency` | `number` |  |  |  |
| `rotation` | `number` |  |  |  |
| `recolor` | `'Grayscale' \| 'Sepia' \| 'Washout'` |  |  |  |
| `width` | `number` |  |  |  |
| `height` | `number` |  |  |  |
| `position` | `ExcelImagePosition` |  |  |  |
| `altText` | `string` |  |  |  |

### ExcelImagePosition

Properties available on the `ExcelImagePosition` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `row` | `number` |  |  |  |
| `rowSpan` | `number` |  |  |  |
| `column` | `number` |  |  |  |
| `colSpan` | `number` |  |  |  |
| `offsetX` | `number` |  |  |  |
| `offsetY` | `number` |  |  |  |

### ExcelInterior

Properties available on the `ExcelInterior` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `pattern` | `\| 'None'         \| 'Solid'         \| 'Gray75'         \| 'Gray50'         \| 'Gray25'         \| 'Gray125'         \| 'Gray0625'         \| 'HorzStripe'         \| 'VertStripe'         \| 'ReverseDiagStripe'         \| 'DiagStripe'         \| 'DiagCross'         \| 'ThickDiagCross'         \| 'ThinHorzStripe'         \| 'ThinVertStripe'         \| 'ThinReverseDiagStripe'         \| 'ThinDiagStripe'         \| 'ThinHorzCross'         \| 'ThinDiagCross'` |  |  |  |
| `color` | `string` |  |  |  |
| `patternColor` | `string` |  |  |  |

### ExcelNumberFormat

Properties available on the `ExcelNumberFormat` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `format` | `string` |  |  |  |

### ExcelProtection

Properties available on the `ExcelProtection` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `protected` | `boolean` |  |  |  |
| `hideFormula` | `boolean` |  |  |  |

### ExcelSheetMargin

Properties available on the `ExcelSheetMargin` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `top` | `number` |  |  |  |
| `right` | `number` |  |  |  |
| `bottom` | `number` |  |  |  |
| `left` | `number` |  |  |  |
| `header` | `number` |  |  |  |
| `footer` | `number` |  |  |  |

### ExcelSheetPageSetup

Properties available on the `ExcelSheetPageSetup` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `orientation` | `'Portrait' \| 'Landscape'` |  |  |  |
| `pageSize` | `\| 'Letter'         \| 'Letter Small'         \| 'Tabloid'         \| 'Ledger'         \| 'Legal'         \| 'Statement'         \| 'Executive'         \| 'A3'         \| 'A4'         \| 'A4 Small'         \| 'A5'         \| 'A6'         \| 'B4'         \| 'B5'         \| 'Folio'         \| 'Envelope'         \| 'Envelope DL'         \| 'Envelope C5'         \| 'Envelope B5'         \| 'Envelope C3'         \| 'Envelope C4'         \| 'Envelope C6'         \| 'Envelope Monarch'         \| 'Japanese Postcard'         \| 'Japanese Double Postcard'` |  |  |  |

### ExcelSheetProtection

Configuration for worksheet protection, used by `ExcelExportParams.protectSheet`.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `autoFilter` | `boolean` |  |  |  |
| `deleteColumns` | `boolean` |  |  |  |
| `deleteRows` | `boolean` |  |  |  |
| `formatCells` | `boolean` |  |  |  |
| `formatColumns` | `boolean` |  |  |  |
| `formatRows` | `boolean` |  |  |  |
| `insertColumns` | `boolean` |  |  |  |
| `insertHyperlinks` | `boolean` |  |  |  |
| `insertRows` | `boolean` |  |  |  |
| `pivotTables` | `boolean` |  |  |  |
| `selectLockedCells` | `boolean` |  |  |  |
| `selectUnlockedCells` | `boolean` |  |  |  |
| `password` | `string` |  |  |  |

### ExcelStyle

Properties available on the `ExcelStyle` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `id` | `string` |  |  |  |
| `alignment` | `ExcelAlignment` |  |  |  |
| `borders` | `ExcelBorders` |  |  |  |
| `dataType` | `ExcelDataType` |  |  |  |
| `font` | `ExcelFont` |  |  |  |
| `interior` | `ExcelInterior` |  |  |  |
| `numberFormat` | `ExcelNumberFormat` |  |  |  |
| `protection` | `ExcelProtection` |  |  |  |

### ExcelTableConfig

Properties available on the `ExcelTableConfig` interface.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `name` | `string` |  |  |  |
| `showFilterButton` | `boolean \| 'match'` |  |  |  |
| `showRowStripes` | `boolean` |  |  |  |
| `showColumnStripes` | `boolean` |  |  |  |
| `highlightFirstColumn` | `boolean` |  |  |  |
| `highlightLastColumn` | `boolean` |  |  |  |

### ProcessNoteForExportParams

Properties available on the `ProcessNoteForExportParams<TData = any, TContext = any>` interface.

See [Notes](https://www.ag-grid.com/archive/36.2.0/vue-data-grid/excel-export-notes/) for more information.

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `gridNote` | `Note` |  |  |  |
| `excelNote` | `ExcelNote` |  |  |  |
| `value` | `any` |  |  |  |
| `accumulatedRowIndex` | `number` |  |  |  |
| `node` | `IRowNode \| null` |  |  |  |
| `column` | `Column` |  |  |  |
| `type` | `string` |  |  |  |
| `parseValue` | `Function` |  |  |  |
| `formatValue` | `Function` |  |  |  |
| `api` | `GridApi` |  |  |  |
| `context` | `TContext` |  |  |  |

## Types

### ExcelDataType

```ts
type ExcelDataType =
    'String'   |
    'Formula'  |
    'Number'   |
    'Boolean'  |
    'DateTime' |
    'Error'
```

### ExcelOOXMLDataType

```ts
type ExcelOOXMLDataType =
    'str'       |
    's'         |
    'f'         |
    'inlineStr' |
    'n'         |
    'b'         |
    'd'         |
    'e'         |
    'empty'
```