JavaScript Data GridCSV Export

The grid data can be exported to CSV with an API call, or using the right-click context menu (Enterprise only) on the Grid.

What Gets Exported

The same data that is in the grid gets exported, but none of the GUI representation of the data will be. What this means is:

The raw values, and not the result of cell renderer will get used, meaning:
- Value Getters will be used.
- Cell Renderers will NOT be used.
- Cell Formatters will NOT be used (use processCellCallback instead), unless Use Value Formatter for Export is enabled.
Cell styles are not exported.
If row grouping:
- All data will be exported regardless of whether groups are open in the UI.
- By default, group names will be in the format "-> Parent Name -> Child Name" (use processRowGroupCallback to change this).
- Row group footers (groupIncludeFooter=true) will NOT be exported - this is a GUI addition only.

The CSV export will be enabled by default. If you want to disable it, you can set the property suppressCsvExport = true in your gridOptions.

Security Concerns

When opening CSV files, spreadsheet applications like Excel, Apple Numbers, Google Sheets and others will automatically execute cell values that start with the following symbols as formulas: +, -, =, @, Tab (0x09) and Carriage Return (0x0D). In order to prevent any malicious content from being exported we recommend using the callback methods shown in the CSV Export Params to modify the exported cell values so that they do NOT start with any of the characters listed above. This way the applications will not execute the cell value directly if it starts with the characters listed above. If you'd like to keep the cell values unchanged when exporting, please allow exporting to Excel only.

Detailed info regarding CSV Injection can be found in the OWASP CSV Injection website.

Standard Export

The example below shows the default behaviour when exporting the grid's data to CSV.

Note the following:

You can use the Show CSV export content text button, to preview the output.
You can use the Download CSV export file button to download a csv file.
The file will be exported using the default name: export.csv.
Community version supports api CSV Export but not Context Menu.

Changing the column separator

By default, a CSV file separates its columns using ,. But this value token could be changed using the columnSeparator param.

Note the following:

You can use the select field at the top to switch the value of the columnSeparator param.
You can use the Show CSV export content text button, to preview the output.
Enterprise version enables CSV Export using right click via the Context Menu.

Suppress Quotes

By default cell values are encoded according to CSV format rules: values are wrapped in double quotes, and any double quotes within the values are escaped, so my"value becomes "my""value". Pass true to insert the value into the CSV file without escaping. In this case it is your responsibility to ensure that no cells contain the columnSeparator character.

Note the following:

You can use the select field at the top to switch the value of the suppressQuotes param.
You can edit the cells to preview the results with different inputs.
You can use the Show CSV export content text button, to preview the output.
You can use the Download CSV export file button to download a csv file.

Prepending and Appending Content

The recommended way to prepend or append content, is by passing an array of CsvCell objects to appendContent or prependContent. This ensures that your content is correctly escaped.

For compatibility with earlier versions of the Grid you can also pass a string, which will be inserted into the CSV file without any processing. You are responsible for formatting the string according to the CSV standard.

Note the following:

You can use select fields at the top to switch the value of prependContent and appendContent.
- With prependContent=CsvCell[][] or appendContent=CsvCell[][], custom content will be inserted containing
commas and quotes. These commas and quotes will be visible when opened in Excel because they have been escaped properly.
- With prependContent=string or appendContent=string, a string to be inserted into the CSV file without any processing, and without being affected by suppressQuotes and columnSeparator. It contains commas and quotes that will not be visible in Excel.
You can use the Show CSV export content text button, to preview the output.
You can use the Download CSV export file button to download a csv file.

Column Headers

In some situations, you could be interested in exporting only the grid data, without exporting the header cells. For this scenario, we provide the skipColumnGroupHeaders=true and skipColumnHeaders=true params.

Note the following:

Initially, grouped headers and header are exported.
Group Headers will be skipped if Skip Column Group Headers is checked.
Normal headers will be skipped if Skip Column Headers is checked.

Pinned Rows

If the pinned rows are not relevant to the data, they can be excluded from the export by using the skipPinnedTop=true and skipPinnedBottom=true params.

Note the following:

By default, all pinned rows are exported.
If Skip Pinned Top Rows is checked, the rows pinned at the top will be skipped.
If Skip Pinned Bottom Rows is checked, the rows pinned at the bottom will be skipped.

Hidden Columns

By default, hidden columns are not exported. If you would like all columns to be exported regardless of the current state of grid, use the allColumns=true params.

Note the following:

By default, only visible columns will be exported. The bronze, silver, and gold columns will not.
If Export All Columns is checked, the bronze, silver, and gold columns will be included in the export.

API

Grid Properties

defaultCsvExportParams TypeCsvExportParams	A default configuration object used to export to CSV.
suppressCsvExport Typeboolean Defaultfalse	Prevents the user from exporting the grid to CSV.

API Methods

exportDataAsCsv TypeFunction	Downloads a CSV export of the grid's data.
getDataAsCsv TypeFunction	Similar to `exportDataAsCsv`, except returns the result as a string rather than download it.

Interfaces

CsvExportParams

Properties available on the CsvExportParams interface.

columnSeparator Typestring Default,	Delimiter to insert between cell values.
suppressQuotes Typeboolean Defaultfalse	By default cell values are encoded according to CSV format rules: values are wrapped in double quotes, and any double quotes within the values are escaped, so my value becomes \"my\"\"value\". Pass `true` to insert the value into the CSV file without escaping. In this case it is your responsibility to ensure that no cells contain the columnSeparator character.
prependContent TypeCsvCustomContent	Content to put at the top of the file export. A 2D array of CsvCell objects (see Prepending and Appending Content). Alternatively, you can pass a multi-line string that is simply appended to the top of the file content.
appendContent TypeCsvCustomContent	Content to put at the bottom of the file export. A 2D array of CsvCell objects (see Prepending and Appending Content). Alternatively, you can pass a multi-line string that is simply appended to the bottom of the file content.
getCustomContentBelowRow TypeFunction	A callback function to return content to be inserted below a row in the export.
allColumns Typeboolean Defaultfalse	If `true`, all columns will be exported in the order they appear in the columnDefs. When `false` only the columns currently being displayed will be exported.
columnKeys Type(string \| Column)[]	Provide a list (an array) of column keys or Column objects if you want to export specific columns.
rowPositions TypeRowPosition[]	Row node positions.
fileName Typestring Defaultexport.csv	String to use as the file name.
exportedRows Type'all' \| 'filteredAndSorted' DefaultfilteredAndSorted	Determines whether rows are exported before being filtered and sorted.
onlySelected Typeboolean Defaultfalse	Export only selected rows.
onlySelectedAllPages Typeboolean Defaultfalse	Only export selected rows including other pages (only makes sense when using pagination).
skipColumnGroupHeaders Typeboolean Defaultfalse	Set to `true` to exclude header column groups.
skipColumnHeaders Typeboolean Defaultfalse	Set to `true` if you don't want to export column headers.
skipRowGroups Typeboolean Defaultfalse	Set to `true` to skip row group headers if grouping rows. Only relevant when grouping rows.
skipPinnedTop Typeboolean Defaultfalse	Set to `true` to suppress exporting rows pinned to the top of the grid.
skipPinnedBottom Typeboolean Defaultfalse	Set to `true` to suppress exporting rows pinned to the bottom of the grid.
shouldRowBeSkipped TypeFunction	A callback function that will be invoked once per row in the grid. Return true to omit the row from the export.
processCellCallback TypeFunction	A callback function invoked once per cell in the grid. Return a string value to be displayed in the export. For example this is useful for formatting date values.
processHeaderCallback TypeFunction	A callback function invoked once per column. Return a string to be displayed in the column header.
processGroupHeaderCallback TypeFunction	A callback function invoked once per column group. Return a `string` to be displayed in the column group header. Note that column groups are exported by default, this option will not work with `skipColumnGroupHeaders=true`.
processRowGroupCallback TypeFunction	A callback function invoked once per row group. Return a `string` to be displayed in the group cell.

CsvCell

Properties available on the CsvCell interface.

data * TypeCsvCellData	The data that will be added to the cell.
mergeAcross Typenumber Default0	The number of cells to span across (1 means span 2 columns).

CsvCellData

Properties available on the CsvCellData interface.

Typestring | null

The value of the cell.

What Gets Exported

Security Concerns

Standard Export

Changing the column separator

Suppress Quotes

Prepending and Appending Content

Column Headers

Pinned Rows

Hidden Columns

API

Grid Properties

defaultCsvExportParams

suppressCsvExport

API Methods

exportDataAsCsv

getDataAsCsv

Interfaces

CsvExportParams

columnSeparator

suppressQuotes

prependContent

appendContent

getCustomContentBelowRow

allColumns

columnKeys

rowPositions

fileName

exportedRows

onlySelected

onlySelectedAllPages

skipColumnGroupHeaders

skipColumnHeaders

skipRowGroups

skipPinnedTop

skipPinnedBottom

shouldRowBeSkipped

processCellCallback

processHeaderCallback

processGroupHeaderCallback

processRowGroupCallback

CsvCell

data *

mergeAcross

CsvCellData

value *