GridExcelExportOptions API
Extended documentation for the GridExcelExportOptions interface with detailed information on the module's properties and available APIs.
Demos
Import
import { GridExcelExportOptions } from '@mui/x-data-grid-premium'The options to apply on the Excel export.
If false, the formulas in the cells will not be escaped.
It is not recommended to disable this option as it exposes the user to potential CSV injection attacks.
See https://owasp.org/www-community/attacks/CSV_Injection for more information.
Type:boolean
Default:true
Method called after adding the rows to the workbook.
Not supported when worker is set.
To use with web workers, use the option in setupExcelExportWebWorker.
Type:(processInput: GridExceljsProcessInput) => Promise<void>
Method called before adding the rows to the workbook.
Not supported when worker is set.
To use with web workers, use the option in setupExcelExportWebWorker.
Type:(processInput: GridExceljsProcessInput) => Promise<void>
The columns exported.
This should only be used if you want to restrict the columns exports.
Type:string[]
Function that returns the list of row ids to export on the order they should be exported.
Type:(params: GridGetRowsToExportParams<Api>) => GridRowId[]
If true, the headers of the column groups will be added into the file.
Type:boolean
Default:true
If true, the first row of the file will include the headers of the grid.
Type:boolean
Default:true
Name given to the worksheet containing the columns valueOptions.
valueOptions are added to this worksheet if they are provided as an array.
Type:string