Options

Summary

Option Description
columns.checkboxes Enables and configures Checkboxes extension for DataTables
columns.checkboxes.selectRow Enables / disables row selection
columns.checkboxes.selectAll Enables / disables “select all” control in the header
columns.checkboxes.selectAllPages Enables / disables ability to select checkboxes from all pages
columns.checkboxes.selectCallback Checkbox select/deselect callback
columns.checkboxes.selectAllCallback “Select all” control select/deselect callback
columns.checkboxes.selectAllRender “Select all” control markup
columns.checkboxes.stateSave Enables / disables checkbox state loading/saving if state saving is enabled globally

Details

columns.checkboxes.selectRow
Enables and configures Checkboxes extension for DataTables.

This option provides the ability to enable and configure Checkboxes extension for DataTables. In its simplest form as the boolean true it will enable Checkboxes with the default configuration options (as defined by $.fn.dataTable.Checkboxes.defaults). It can also be used as an object to provide custom configuration options.

Type:
Boolean

columns.checkboxes.selectRow
Enables / disables row selection.

Type:
Boolean

Default:
false

columns.checkboxes.selectAll
Enables / disables “select all” control in the header.

Type:
Boolean

Default:
true

columns.checkboxes.selectAllPages
Enables / disables ability to select checkboxes from all pages.

Please note that ability to select checkboxes from all pages is only available in the client-side processing mode. In server-side processing mode only current page checkboxes would be selected when user clicks on “select all” control in the header.

Type:
Boolean

Default:
true

columns.checkboxes.selectCallback
Checkbox select/deselect callback.

Type:
Function

Parameters:

Name Type
1. nodes Array
List of cell nodes td containing checkboxes.
2. selected Boolean
Flag indicating whether checkbox has been checked.

Default:
null

Available Since:
Version 1.2

columns.checkboxes.selectAllCallback
“Select all” control select/deselect callback

Type:
Function

Parameters:

Name Type
1. nodes Array
List of cell nodes td containing checkboxes.
2. selected Boolean
Flag indicating whether checkbox has been checked.
3. indeterminate Boolean
Flag indicating whether “Select all” checkbox has indeterminate state.

Default:
null

Available Since:
Version 1.2

columns.checkboxes.selectAllRender
“Select all” control markup.

Type:
String

Default:
<input type="checkbox">

Available Since:
Version 1.2.8

columns.checkboxes.stateSave
Enables / disables checkbox state loading/saving if state saving is enabled globally.

Type:
Boolean

Default:
true

Available Since:
Version 1.2.10