buttons.exportInfo()

自：Buttons 1.4.0 起

取得許多不同按鈕類型通用的匯出元資訊。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。

描述

Buttons 最常用的功能是其顯示按鈕以匯出表格資料的能力 - 複製到剪貼簿、列印或本地建立的資料檔案。每個提供此功能的按鈕類型都有其自己的選項範圍（例如，CSV 按鈕類型可以將欄位分隔符號修改為 TSV 匯出），此外還有每個按鈕類型通用的選項。此方法提供這些通用選項，確保 API 的一致性以及程式碼的重複使用。

一般來說，您不太可能在匯出按鈕之外使用此方法，但它可公開用於自訂按鈕。

類型

function buttons.exportInfo( [ options ] )

描述

參數

名稱類型可選

	名稱	類型	可選
1	`options`	`物件`	是
	此選項通常是按鈕設定物件 - 即用於定義按鈕行為的物件，允許各種按鈕類型使用一組通用選項，以提供相同的一致功能。此物件使用的屬性為 `extension` - 如果按鈕建立了外部檔案，則應附加到 `filename` 選項的檔案名稱副檔名。 `string` - 應使用的靜態字串 `function` - 解析函數並使用傳回的值 `filename` - 如果建立外部檔案，要給檔案的名稱。 `` (預設) - 使用 HTML 頁面的 `title` 元素的值 `string` - 應使用的靜態字串 `function` - 解析函數並使用傳回的值 `messageBottom` - 顯示在匯出表格下方 `` (預設) - 如果表格有 `caption` 標籤且設定為 `caption-side: bottom`，則使用表格的 `caption` 標籤的值。 `null` - 不在輸出中顯示底部訊息 `string` - 應使用的靜態字串 `function` - 解析函數並使用傳回的值 `messageTop` - 顯示在匯出文件中標題和表格之間 `` (預設) - 如果表格有 `caption` 標籤且設定為 `caption-side: top`，則使用表格的 `caption` 標籤的值。 `null` - 不在輸出中顯示頂部訊息 `string` - 應使用的靜態字串 `function` - 解析函數並使用傳回的值 `title` - 顯示在匯出文件最頂部 `` (預設) - 使用 HTML 頁面的 `title` 值。 `null` - 不在輸出中顯示標題 `string` - 應使用的靜態字串 `function` - 解析函數並使用傳回的值請注意，對於每個選項，當以函數形式給定時，傳回值應為字串。此外，該函數會傳遞以下參數按鈕的設定物件（自 Buttons 3.0 起）相關表格的 DataTables API 實例（自 Buttons 3.0 起）。

options

物件

是

此選項通常是按鈕設定物件 - 即用於定義按鈕行為的物件，允許各種按鈕類型使用一組通用選項，以提供相同的一致功能。

此物件使用的屬性為

extension - 如果按鈕建立了外部檔案，則應附加到 filename 選項的檔案名稱副檔名。
- string - 應使用的靜態字串
- function - 解析函數並使用傳回的值
filename - 如果建立外部檔案，要給檔案的名稱。
- * (預設) - 使用 HTML 頁面的 title 元素的值
- string - 應使用的靜態字串
- function - 解析函數並使用傳回的值
messageBottom - 顯示在匯出表格下方
- * (預設) - 如果表格有 caption 標籤且設定為 caption-side: bottom，則使用表格的 caption 標籤的值。
- null - 不在輸出中顯示底部訊息
- string - 應使用的靜態字串
- function - 解析函數並使用傳回的值
messageTop - 顯示在匯出文件中標題和表格之間
- * (預設) - 如果表格有 caption 標籤且設定為 caption-side: top，則使用表格的 caption 標籤的值。
- null - 不在輸出中顯示頂部訊息
- string - 應使用的靜態字串
- function - 解析函數並使用傳回的值
title - 顯示在匯出文件最頂部
- * (預設) - 使用 HTML 頁面的 title 值。
- null - 不在輸出中顯示標題
- string - 應使用的靜態字串
- function - 解析函數並使用傳回的值

請注意，對於每個選項，當以函數形式給定時，傳回值應為字串。此外，該函數會傳遞以下參數

按鈕的設定物件（自 Buttons 3.0 起）
相關表格的 DataTables API 實例（自 Buttons 3.0 起）。

傳回值

物件

具有以下參數的物件

filename - 應由按鈕建立的任何檔案使用的檔案名稱
messageTop - 顯示在匯出資料內容頂部的訊息（在 title 之後）
messageBottom - 顯示在匯出資料內容結尾的訊息
title - 顯示在匯出資料中的標題。

範例

在自訂按鈕中取得匯出資訊

var table = new DataTable('#myTable', {
	buttons: [
		{
			text: 'My button',
			action: function (e, dt, button, config) {
				var info = dt.buttons.exportInfo();
				// Do something with the 'info' variable when creating custom export
			}
		}
	]
});