ExportParams
Since v0.1.1
Parameters for a specific export operation
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
format | ExportFormat | Export format |
fileName? | string | File name for the export (without extension) |
fileExtension? | string | Override the file extension for Excel export. |
columns? | string[] | Specific column fields to export |
rowIndices? | number[] | Specific row indices to export |
includeHeaders? | boolean | Include column headers in export |
processCell? | (value: any, field: string, row: any) => any | Custom cell value processor |
processHeader? | (header: string, field: string) => string | Custom header processor |
processHeaderRow? | (cell: HeaderRowCell, rowIndex: number) => HeaderRowCell | unknown | Custom processor for cells in plugin-contributed header rows (e.g. the column-group header row above the leaf headers). Runs once per cell. v2.10.0+ |
mode? | ExportMode | Controls how cell values are produced. See ExportMode. |
excelStyles? | ExcelStyleConfig | Excel style configuration (only applies to Excel export) |
headerRows? | HeaderRowContribution[] | Plugin-contributed extra header rows that sit above the leaf header row. Normally populated automatically from the 'collectHeaderRows' broadcast in ExportPlugin.export*(); you only set it manually when calling the pure formatters (ExportPlugin.formatCsv / ExportPlugin.formatExcel) with pre-built row data. v2.10.0+ |
Property Details
Section titled “Property Details”fileExtension
Section titled “fileExtension”Override the file extension for Excel export.
Defaults to '.xls' so the file opens in Excel on most operating systems.
Set to '.xml' to avoid Excel’s “format mismatch” warning — but note
that .xml files open in a browser by default on most systems.
Only applies to Excel format exports.
processHeaderRow
Section titled “processHeaderRow”Custom processor for cells in plugin-contributed header rows (e.g. the column-group header row above the leaf headers). Runs once per cell.
Return null to blank a cell (its span is preserved so neighbours stay
aligned). If every cell in a row is blank after processing, the
entire row is dropped from the output. Return the same cell unchanged
to keep it as-is.
Controls how cell values are produced. See ExportMode.
Default: 'raw' — preserves current behaviour (passthrough + processCell).
Use 'formatted' to apply column-type defaults and column.format so the
output mirrors what the grid displays.
headerRows
Section titled “headerRows”Plugin-contributed extra header rows that sit above the leaf header
row. Normally populated automatically from the 'collectHeaderRows'
broadcast in ExportPlugin.export*(); you only set it manually when
calling the pure formatters (ExportPlugin.formatCsv /
ExportPlugin.formatExcel) with pre-built row data.
Ignored when includeHeaders is false.