ExportParams

Since v0.1.1

Parameters for a specific export operation *

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+