列印
按鈕顯示表格資料的可列印檢視。
請注意 - 此屬性需要 DataTables 的 Buttons 擴充功能。
描述
列印檢視按鈕將複製表格中顯示的資料 (基於 exportOptions
參數中給定的選擇器選項),並建構一個新的臨時表格,該表格顯示在新視窗中。然後自動調用瀏覽器的 print
命令 (儘管可以禁用此功能 - 請參閱下面的 autoPrint
選項),最後當列印操作完成或最終使用者取消時關閉視窗。
建構的表格不會保留原始表格的完整資訊 (例如,不會複製表格列和單元格類別),但原始文件的樣式表會複製到列印文件中,以便保留表格的基本樣式。
可透過 title
和 message
選項自訂列印檢視以取得簡單的描述字串,並透過 customize
選項完整控制產生的文件 (例如,允許新增圖像等)。
請注意,列印按鈕會將 buttons.exportData()
的 decodeEntities
選項設定為 false
,以防止 XSS 攻擊。
選項
除了所有按鈕可用的選項 (例如 buttons.buttons.text
) 外,此按鈕可以在其組態物件中設定以下選項以自訂其動作和顯示。
名稱 | 類型 | 預設值 |
---|---|---|
action | ||
顯示列印檢視 | ||
autoPrint | true | |
指出在顯示列印檢視頁面時是否應呼叫瀏覽器的
| ||
className | buttons-print | |
按鈕的類別名稱。請參閱 | ||
customScripts | null | |
指向應包含在列印檢視文件中的腳本 URL 的陣列。這對於包含正確顯示文件所需的其他函式庫很有用。當顯示包含列印檢視文件的視窗時執行的函式。 | ||
customize | null | |
當顯示包含列印檢視文件的視窗時執行的函式。 自 Buttons 1.5.2 起,此函式傳遞三個參數
不預期或處理傳回值。 | ||
exportOptions | {} | |
選取要從 DataTable 收集以供匯出的資料。這包括哪些列、行、排序和搜尋的選項。請參閱 | ||
footer | true | |
指出是否應在列印檢視中包含表格頁腳。請注意,此參數的預設值已在 Buttons 3.0.1 中更新為 | ||
header | true | |
指出是否應在列印檢視中包含表格標頭。 | ||
message | ||
可以在列印檢視文件中顯示的描述訊息。這可以包含 HTML。 除了字串值之外,還可以將函式指定給
| ||
messageBottom 自:1.4.0 起 | * | |
顯示在表格底部的訊息,如果顯示在表格底部,則顯示為 | ||
messageTop 自:1.4.0 起 | * | |
顯示在表格頂部的訊息,如果顯示在表格頂部,則顯示為 | ||
text | 列印 | |
按鈕的顯示文字。可以使用此選項設定文字 (請參閱 | ||
title | * | |
將包含在匯出資料中的表格標題。請參閱 |
範例
DataTables 初始化:顯示列印按鈕
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['print']
}
}
});
DataTables 初始化:停用列印對話方塊的自動顯示
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'print',
text: 'Print current page',
autoPrint: false
}
]
}
}
});
DataTables 初始化:使用 exportOptions
僅列印目前的 DataTable 頁面
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'print',
text: 'Print current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});