excel
建立並儲存一個 Excel CSV 檔案,其中包含表格中的資料。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。
說明
此按鈕類型作為一個代理,將根據瀏覽器的功能和頁面上可用的函式庫自動偵測是否可以使用 excelHtml5
按鈕。
提供此選項的原因是 HTML5 按鈕類型需要相當現代的瀏覽器,而最終使用者可能不一定能使用。
如果未滿足 excelHtml5
按鈕的需求,則不會向最終使用者顯示任何按鈕。 有關每種按鈕類型的需求,請參閱其各自的文件。
樣式和自訂
有關如何自訂建立的 XLSX 檔案的資訊,請參閱 excelHtml5
按鈕文件中的自訂章節。
選項
除了所有按鈕都可用的選項(例如 buttons.buttons.text
)外,此按鈕還可以在其配置物件中設定以下選項,以自訂其動作和顯示。
名稱 | 類型 | 預設值 |
---|---|---|
action | ||
建立並儲存 Excel 檔案。 | ||
className | buttons-excel | |
按鈕的類別名稱。 有關詳細資訊,請參閱 | ||
createEmptyCells 自:1.5.0 | false | |
指示 Excel 匯出建立空儲存格的選項。 預設情況下,如果儲存格包含 | ||
customize 自:1.2.0 | 未定義 | |
此方法可用於修改 Buttons 建立的 XSLX 檔案。 傳入的第一個參數是一個物件,其中包含 XML 檔案,並且物件結構與 XSLX 檔案中這些檔案的檔案系統路徑相符。 自訂 XSLX 檔案是一個複雜的主題 - 有關完整詳細資訊,請參閱 自 Buttons 1.5.2 起,此函式會傳遞三個參數
| ||
exportOptions | {} | |
選擇要從 DataTable 中收集以進行匯出的資料。 這包括用於選擇哪些列、行、排序和搜尋的選項。 有關完整詳細資訊,請參閱 | ||
extension | .xlsx | |
給予建立的檔案名稱的副檔名。 | ||
filename | * | |
給予建立的檔案的檔案名稱(加上 | ||
footer | false | |
指出是否應在匯出的資料中包含表格頁腳。 | ||
header | true | |
指出是否應在匯出的資料中包含表格標頭。 | ||
messageBottom 自:1.4.0 | * | |
顯示在表格底部的訊息,如果顯示在表格底部,則顯示在 | ||
messageTop 自:1.4.0 | * | |
顯示在表格頂部的訊息,如果顯示在表格頂部,則顯示在 | ||
sheetName | Sheet1 | |
在建立的 Excel 檔案中的工作表名稱。 不允許使用字元 [] \ /: *? :,如果存在將會被移除。 | ||
text | Excel | |
按鈕的顯示文字。 可以使用此選項 (請參閱 | ||
title 自:1.4.0 | * | |
將包含在匯出資料中的表格標題。 請參閱 |
範例
DataTables 初始化:使用 excel
按鈕類型自動別名 HTML 按鈕選項。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['excel']
}
}
});
DataTables 初始化:使用 exportOptions
僅儲存目前 DataTable 頁面上顯示的資料
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'excel',
text: 'Save current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});