跳到主要內容

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 Worker 一起使用,請使用 setupExcelExportWebWorker 中的選項。

類型:(processInput: GridExceljsProcessInput) => Promise<void>


選填

在將列新增到工作簿之前呼叫的方法。
當設定 worker 時不支援。
若要與 Web Worker 一起使用,請使用 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