複製
將表格資料複製到剪貼簿的按鈕。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。
說明
此按鈕類型作為一個代理,它會根據瀏覽器的功能和頁面上可用的函式庫自動偵測是否可以使用 copyHtml5
按鈕。
提供此功能是因為 HTML5 中沒有 API 允許在點擊按鈕時執行複製到剪貼簿的操作。
如果 copyHtml5
按鈕的要求未滿足,則不會向最終用戶顯示任何按鈕。 關於每個按鈕類型的要求,請參閱其各自的文件。
選項
除了所有按鈕可用的選項(例如,buttons.buttons.text
)之外,此按鈕還可以在其組態物件中設定以下選項來自訂其動作和顯示。
名稱 | 類型 | 預設 |
---|---|---|
action | ||
顯示一個對話方塊,用戶可以使用該對話方塊將表格資料複製到剪貼簿 | ||
className | buttons-copy | |
按鈕的類別名稱。有關詳細資訊,請參閱 | ||
copySuccess 自:3.1.2 起 | true | |
指示複製完成時是否應顯示訊息。 | ||
customize 自:1.1.1 起 | undefined | |
可用於修改匯出資料內容的函式。該函式接受兩個參數,即按鈕設定的資料和按鈕的組態物件。函式返回的值將用於匯出。 如果您希望在匯出的資料中新增公司標頭或頁尾、描述資料或任何其他資訊,這會特別有用。 自 Buttons 1.5.2 起,此函式傳遞三個參數
| ||
exportOptions | {} | |
從 DataTable 中選擇要收集以進行匯出的資料。這包括哪些欄、列、排序和搜尋的選項。請參閱 | ||
fieldBoundary | ||
用於在複製到系統剪貼簿的表格純文字表示形式中,將每個欄位括起來的字元。這會在每個儲存格資料的開頭和結尾自動新增。 | ||
fieldSeparator | \t | |
用於在複製到系統剪貼簿的表格純文字表示形式中,分隔欄位的字元。 | ||
footer | false | |
指示是否應在匯出的資料中包含表格頁尾。 | ||
header | true | |
指示是否應在匯出的資料中包含表格標頭。 | ||
messageBottom 自:1.4.0 起 | * | |
顯示在表格底部或 | ||
messageTop 自:1.4.0 起 | * | |
顯示在表格頂部或 | ||
newline | \n | |
用於分隔資料行的字元。請注意,在 Windows 用戶端上,預設值為 | ||
text | 複製 | |
按鈕的顯示文字。可以使用此選項 (請參閱 | ||
title 自:1.4.0 起 | * | |
將包含在匯出資料中的表格標題。有關與此參數相關的所有選項,請參閱 |
範例
DataTables 初始化:使用 copy
按鈕類型來別名 HTML 按鈕選項。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['copy']
}
}
});
DataTables 初始化:使用 exportOptions
僅複製當前 DataTable 頁面
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'copy',
text: 'Copy current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});