pdf

自：Buttons 1.0.0

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

描述

此按鈕類型作為一個代理，它會根據瀏覽器的功能和頁面上可用的程式庫自動偵測是否可以使用 pdfHtml5 按鈕。

提供此選項是因為 HTML5 按鈕類型需要相當現代的瀏覽器，而最終使用者可能不一定擁有此瀏覽器。

如果不滿足 pdfHtml5 按鈕的要求，則不會向最終使用者顯示任何按鈕。有關每個按鈕類型的要求，請參閱其各自的說明文件。

選項

此按鈕可以在其設定物件中設定以下選項，以自訂其動作和顯示，此外還有適用於所有按鈕的選項（例如 buttons.buttons.text）

名稱	類型	預設值
`action`
建立並儲存 PDF 檔案。
`className`		buttons-pdf
按鈕的類別名稱。有關詳細資訊，請參閱 `buttons.buttons.className`。
`customize`		null
一個可以用於自訂 `pdfHtml5` 按鈕的 PDFMake 文件定義物件的函式。文件物件會作為此函式的第一個參數傳入，並應根據需要進行操作。不預期或使用傳回值。有關如何操作此物件以及可用於產生的 PDF 的選項的資訊，請參閱 PDFMake 說明文件。從 Buttons 1.5.2 開始，此函式會傳遞三個參數一個包含 PDFMake 文件結構的物件。按鈕設定物件一個按鈕所屬表格的 DataTables API 實例。
`exportOptions`		{}
選擇要從 DataTable 收集用於匯出的資料。這包括用於選擇欄、列、排序和搜尋的選項。有關完整詳細資訊，請參閱 `buttons.exportData()` 方法 - 由此參數給定的物件會直接傳遞到該動作以收集所需的資料。
`extension`		.pdf
給予建立檔案名稱的副檔名。
`filename`		*
給予建立檔案的檔案名稱（加上 `extension` 選項定義的副檔名）。特殊字元 `*` 會自動替換為從主機文件的 `title` 標籤讀取的值。
`footer`		true
指示表格頁尾是否應包含在匯出的資料中。請注意，此參數的預設值已在 Buttons 3.0.1 中更新為 `true`。在較早的版本中，它是 `false`。
`header`		true
指示表格標題是否應包含在匯出的資料中。
`message`
`在建立的 PDF 中，將顯示在表格上方的可選描述訊息。請注意，此選項現在已被取代，改為使用`messageTop` 選項。
`messageBottom` 自：1.4.0		*
顯示在表格底部或 `caption` 標籤（如果顯示在表格底部）的訊息。
`messageTop` 自：1.4.0		*
顯示在表格頂部或 `caption` 標籤（如果顯示在表格頂部）的訊息。
`orientation`		portrait
建立的 PDF 的紙張方向。可以是 `portrait` 或 `landscape`。
`pageSize`		A4
建立的 PDF 的紙張大小。可以是 `A3`、`A4`、`A5`、`LEGAL`、`LETTER` 或 `TABLOID`。
`text`		PDF
按鈕的顯示文字。可以使用此選項（請參閱 `buttons.buttons.text`）或 DataTables `language` 物件的 `buttons.copy` 選項來設定文字。
`title`		*
文件標題（顯示在產生的 PDF 中的表格上方）。特殊字元 `*` 會自動替換為從主機文件的 `title` 標籤讀取的值。

範例

DataTables 初始化：使用 pdf 按鈕類型來建立 HTML 按鈕選項的別名。

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

DataTables 初始化：使用 exportOptions 僅儲存目前 DataTable 頁面上顯示的資料

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: [
				{
					extend: 'pdf',
					text: 'Save current page',
					exportOptions: {
						modifier: {
							page: 'current'
						}
					}
				}
			]
		}
	}
});