csvHtml5

自：Buttons 1.0.0 起

建立並儲存一個包含表格資料的 CSV 檔案 (HTML5)。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。

說明

此按鈕提供最終使用者將表格資料儲存到本機建立的逗號分隔值 (CSV) 檔案的功能。該檔案隨後可以被各種程式使用，包括試算表和資料分析應用程式。

如果您的表格的標頭或頁尾有多行，這些都將包含在匯出中。如果標頭或頁尾包含 colspan 或 rowspan 儲存格，它們將由空字串填入，因為 CSV 是一個純文字檔案，沒有辦法表示跨越多個儲存格的資料格。

選項

除了所有按鈕可用的選項 (例如 buttons.buttons.text) 之外，此按鈕還可以在其配置物件中設定以下選項來自訂其動作和顯示。

名稱	類型	預設值
`action`
建立並儲存一個 CSV 檔案。
`bom` 自：1.2.2 起		false
選擇是否包含 UTF-8 位元組順序標記 (`true`) 或不包含 (`false`)。預設情況下禁用此選項，因為Unicode 標準聲明，UTF-8 不需要也不建議使用 BOM。
`charset`		null
在檔案匯出中使用的字元集。當使用 `null` (預設值) 時，將讀取並使用文件的字元集 (`document.characterSet`)。可以透過將此屬性設定為 `false` 來禁用字元集的添加。
`className`		buttons-csv buttons-html5
按鈕的類別名稱。請參閱 `buttons.buttons.className` 以取得詳細資訊。
`customize` 自：1.1.1 起		undefined
可用於修改匯出資料內容的函式。該函式接受兩個參數，一個是按鈕設定的資料，另一個是按鈕的配置物件。該函式返回的值將用作匯出的值。如果您想在匯出的資料中新增公司標頭或頁尾、描述資料或任何其他資訊，這會特別有用。自 Buttons 1.5.2 起，此函式會傳遞三個參數 CSV 資料，以字串表示按鈕配置物件按鈕所屬表格的 DataTables API 實例。
`escapeChar`		"
用於 CSV 資料的逸出字元。此字元將附加到在欄位中找到的任何與 `fieldBoundary` 選項設定相符的資料之前。這是一個可配置的選項，因為不同的應用程式可能需要不同的選項 - 但是預設值與 RFC4180 相符。
`exportOptions`		{}
選擇要從 DataTable 中收集用於匯出的資料。這包括選擇要匯出的欄、列、排序和搜尋的選項。請參閱 `buttons.exportData()` 方法以取得完整詳細資訊 - 此參數提供的物件會直接傳遞到該動作中，以收集所需的資料。
`extension`		.csv
賦予建立的檔案名稱的副檔名。
`fieldBoundary`		"
用於將表格純文字表示形式中每個欄位括起來的字元，該表格會儲存在 CSV 檔案中。此字元會自動添加到每個儲存格資料的開頭和結尾。
`fieldSeparator`		,
用於分隔表格純文字表示形式中欄位的字元，該表格會儲存在 CSV 檔案中。
`filename`		*
賦予建立的檔案的檔案名稱 (加上 `extension` 選項定義的副檔名)。特殊字元 `*` 會自動替換為主機文件 `title` 標籤中讀取的值。
`footer`		true
指示是否應在匯出的資料中包含表格頁尾。請注意，此參數的預設值已在 Buttons 3.0 中更新為 `true`。在較早的版本中，它是 `false`。
`header`		true
指示是否應在匯出的資料中包含表格標頭。
`newline`		\n
用於分隔資料行的字元。請注意，在 Windows 用戶端上，預設值為 `\r\n`。所有其他平台的預設值僅為 `\n`。
`text`		CSV
按鈕的顯示文字。可以使用此選項設定文字 (請參閱 `buttons.buttons.text`) 或 DataTables `language` 物件的 `buttons.copy` 選項。

範例

DataTables 初始化：使用 HTML5 CSV 按鈕

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['csvHtml5']
		}
	}
});

DataTables 初始化：使用 csv 按鈕類型來為 HTML 按鈕選項設定別名。

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['csv']
		}
	}
});

DataTables 初始化：使用 exportOptions 來儲存所有資料，無論是否篩選

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: [
				{
					extend: 'csvHtml5',
					text: 'Copy all data',
					exportOptions: {
						modifier: {
							search: 'none'
						}
					}
				}
			]
		}
	}
});