select.headerCheckbox
控制是否自動加入表頭核取方塊。
請注意 - 此屬性需要 DataTables 的 Select 擴充套件。
描述
如果您使用 DataTable.render.checkbox
渲染函式(屬於 Select 擴充套件的一部分)在 DataTable 中提供核取方塊欄,Select 將會自動在表頭插入一個核取方塊,以便匯總目前的選取狀態,並讓終端使用者能輕鬆選取/取消選取所有列。此選項可用於停用核取方塊,如果您在 DataTables 中使用伺服器端處理(serverSide
),這可能特別有用,因為項目選取是 Select 中的用戶端概念(即您只能選取用戶端上可用的列 - 即 select-page
)。
核取方塊的「全選」動作將會選取 DataTable 目前搜尋結果集中的所有列 - 即,如果某列因搜尋條件而被移除,則不會被選取。但是,「取消全選」動作將導致所有列被取消選取,無論它們是否因套用的搜尋而被篩選出來。
同樣地,如果 DataTable 目前搜尋結果集中的所有列都被選取,則表頭核取方塊將顯示為已選取。如果沒有選取任何列,則會顯示為未選取。否則,將顯示為「中間」狀態。
類型
布林值
- 描述
啟用時,任何使用 Select 提供的
DataTable.render.checkbox()
渲染器的欄,其表頭儲存格都會加入一個全域核取方塊。請注意,當使用伺服器端處理時,此選項的運作方式與設定為
select-page
時相同 - 即,只能選取目前可見頁面上的列。
字串
- 描述
自 Select 2.0.2 起,此選項也可以指定為字串,它可以採用以下其中一個值
none
- 停用表頭核取方塊(與將此值設定為false
相同)select-all
- 選取表格中的所有列(與將此值設定為true
相同)select-page
- 選取目前頁面中的所有列(僅限可見列)。
預設值
- 值:
true
範例
停用表頭核取方塊的加入
new DataTable('#example', {
columnDefs: [
{
orderable: false,
render: DataTable.render.select(),
targets: 0
}
],
select: {
style: 'os',
selector: 'td:first-child',
headerCheckbox: false
},
order: [[1, 'asc']]
});
啟用表頭核取方塊的加入,並使其僅選取目前頁面上的列
new DataTable('#example', {
columnDefs: [
{
orderable: false,
render: DataTable.render.select(),
targets: 0
}
],
select: {
style: 'multi',
selector: 'td:first-child',
headerCheckbox: 'select-page'
},
order: [[1, 'asc']]
});