csv
建立並儲存包含表格資料的 CSV 檔案。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。
描述
此按鈕類型作為一個代理,將根據瀏覽器的功能和頁面上可用的函式庫,自動偵測是否可以使用 csvHtml5
按鈕。
提供此選項是因為 HTML5 按鈕類型需要相當現代化的瀏覽器,而使用者可能不一定可以使用。
如果沒有滿足 csvHtml5
按鈕的需求,則不會向使用者顯示任何按鈕。有關每個按鈕類型的需求,請參閱其各自的文件。
選項
除了所有按鈕可用的選項(例如:buttons.buttons.text
),此按鈕還可以在其配置物件中設定以下選項,以自訂其操作和顯示。
名稱 | 類型 | 預設值 |
---|---|---|
action | ||
建立並儲存 CSV 檔案。 | ||
bom 自:1.2.2 起 | false | |
選項,是否包含 UTF-8 位元組順序標記 ( | ||
charset | null | |
用於檔案匯出的字元集。當使用 | ||
className | buttons-csv buttons-html5 | |
按鈕的類別名稱。有關詳細資訊,請參閱 | ||
customize 自:1.1.1 起 | undefined | |
可以用於修改匯出資料內容的函式。此函式接收兩個參數:按鈕配置的資料以及按鈕的配置物件。函式傳回的值將會用於匯出。 如果您希望在匯出的資料中新增公司標頭或頁尾、描述資料或任何其他資訊,此功能特別有用。 從 Buttons 1.5.2 開始,此函式會傳遞三個參數
| ||
escapeChar | " | |
用作 CSV 資料跳脫字元的字元。此字元會被加在與 | ||
exportOptions | {} | |
選取要從 DataTable 收集以進行匯出的資料。這包括要匯出的欄位、列、排序和搜尋的選項。有關詳細資訊,請參閱 | ||
extension | .csv | |
給予所建立檔案的副檔名。 | ||
fieldBoundary | " | |
用於括住複製到系統剪貼簿的表格純文字表示法中每個欄位的字元。這會自動新增到每個儲存格資料的開頭和結尾。 | ||
fieldSeparator | , | |
用於分隔複製到系統剪貼簿的表格純文字表示法中欄位的字元。 | ||
filename | * | |
給予所建立檔案的名稱(加上 | ||
footer | false | |
指示是否應將表格頁尾包含在匯出的資料中。 | ||
header | true | |
指示是否應將表格標頭包含在匯出的資料中。 | ||
newline | \n | |
用於分隔資料行的字元。請注意,在 Windows 用戶端上,預設值為 | ||
text | CSV | |
按鈕的顯示文字。可以使用此選項設定文字(請參閱 |
範例
DataTables 初始化:使用 HTML5 CSV 按鈕
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['csv']
}
}
});
DataTables 初始化:使用 exportOptions
儲存所有資料,無論篩選條件為何
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'csv',
text: 'Copy all data',
exportOptions: {
modifier: {
search: 'none'
}
}
}
]
}
}
});