跳到内容

GridCsvExportOptionsAPI

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

演示

导入

import { GridCsvExportOptions } from '@mui/x-data-grid-premium'
// or
import { GridCsvExportOptions } from '@mui/x-data-grid-pro'
// or
import { GridCsvExportOptions } from '@mui/x-data-grid'


应用于 CSV 导出的选项。

属性

可选

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

类型:boolean

默认:false

可选

用于分隔字段的字符。

类型:string

默认:','

可选

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

类型:boolean

默认:true

可选

导出的列。
仅当您想要限制列导出时才应使用此项。

类型:string[]

可选

用作文件名的字符串。

类型:string

默认:document.title

可选

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

类型:(params: GridCsvGetRowsToExportParams) => GridRowId[]

可选

如果为 true，则 CSV 将包含列组。

类型:boolean

默认:true

可选

如果为 true，则 CSV 将包含列标题和列组。
使用 includeColumnGroupsHeaders 来控制是否包含列组。

类型:boolean

默认:true

可选

如果为 true，UTF-8 字节顺序标记 (BOM) 将作为导出文件的前缀。
这可以允许 Excel 自动检测文件编码为 UTF-8。

类型:boolean

默认:false