跳过内容

GridExcelExportOptionsAPI

GridExcelExportOptions 接口的扩展文档，其中包含有关模块属性和可用 API 的详细信息。

演示

导入

import { GridExcelExportOptions } from '@mui/x-data-grid-premium'


应用于 Excel 导出的选项。

属性

可选

如果为 true，则隐藏列也将被导出。

类型：boolean

默认值：false

可选

将列字段映射到 Exceljs 样式的对象

类型：ColumnsStylesInterface

可选

如果为 false，则单元格中的公式将不会被转义。
不建议禁用此选项，因为它会使用户面临潜在的 CSV 注入攻击。
有关更多信息，请参阅 https://owasp.org/www-community/attacks/CSV_Injection。

类型：boolean

默认值：true

可选

在将行添加到工作簿后调用的方法。
当设置了 worker 时，不支持此选项。
要与 Web Workers 一起使用，请使用 setupExcelExportWebWorker 中的选项。

类型：(processInput: GridExceljsProcessInput) => Promise<void>

可选

在将行添加到工作簿之前调用的方法。
当设置了 worker 时，不支持此选项。
要与 Web Workers 一起使用，请使用 setupExcelExportWebWorker 中的选项。

类型：(processInput: GridExceljsProcessInput) => Promise<void>

可选

导出的列。
如果您只想限制列导出，则应仅使用此项。

类型：string[]

可选

用作文件名的字符串。

类型：string

默认值：document.title

可选

返回要导出的行 ID 列表的函数，列表顺序应与导出顺序一致。

类型：(params: GridGetRowsToExportParams<Api>) => GridRowId[]

可选

如果为 true，则列组的标题将添加到文件中。

类型：boolean

默认值：true

可选

如果为 true，则文件的第一行将包含表格的标题。

类型：boolean

默认值：true

可选

赋予包含列 valueOptions 的工作表的名称。
如果 valueOptions 以数组形式提供，则会将其添加到此工作表。

类型：string

可选

返回要调用的 Worker 实例的函数。

类型：() => Worker