跳到主要內容

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