Customising Cell and Row Group values
By default, the values exported to Excel will be formatted via the Using the Value Formatter for Export feature.
The grid cell and row group values can be customised specifically for Excel export using the following function params for a call to exportDataAsExcel
API method or in the defaultExcelExportParams
.
gridApi.exportDataAsExcel({
processCellCallback(params) {
const value = params.value
return value === undefined ? '' : `_${value}_`
},
processRowGroupCallback(params) {
return `row group: ${params.node.key}`
}
})
See below the functions on the ExcelExportParams
interface to customise exported grid cell and row group values.
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.
|
A callback function invoked once per row group. Return a string to be displayed in the group cell.
|
The following example shows Excel customisations where the exported document has the following:
- All row groups with the prefix
row group:
- All cell values surrounded by
_
, unless they areundefined
, in which case they are empty
Row group column cells are also cells. This means that each row group column cell will first have the processRowGroupCallback
invoked for it, and then the returned value will have processCellCallback
invoked for it. This is why exported row group cell values will have the _
surrounding the value, which is applied by the processCellCallback
.
When using row grouping while hiding open parents (groupHideOpenParents=true
), export to Excel doesn't export the group rows as collapsible groups in Excel. Instead, all exported rows are on the same level and cannot be expanded/collapsed in Excel.
Customising Column Headers and Group Header Values
The column headers and group headers exported to Excel can be customised using the following function params for a call to exportDataAsExcel
API method or in the defaultExcelExportParams
.
gridApi.exportDataAsExcel({
processGroupHeaderCallback(params) {
return `group header: ${params.api.getDisplayNameForColumnGroup(params.columnGroup, null)}`
},
processHeaderCallback(params) {
return `header: ${params.api.getDisplayNameForColumn(params.column, null)}`
}
});
See below the functions on the ExcelExportParams
interface to customise exported column group headers and headers.
A callback function invoked once per column. Return a string to be displayed in the column header.
|
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 .
|
The following example shows Excel customisations where the exported document has the following:
- Group headers with the prefix
group header:
- Headers with the prefix
header:
Next Up
Continue to the next section: Images.