{hero}

searchPanes

Since: SearchPanes 1.0.0

Enable Search Panes.
Please note - this property requires the SearchPanes extension for DataTables.

Description

SearchPanes is an extension that allows for clearer more accessible searching functionality.

When a selection is made in one of the associated panes, the DataTable will be searched for records that meet the criteria of the selections made in the panes. These records will then be displayed while all of the records that do not meet the criteria will not be included in the DataTable.

SearchPanes can be enabled through the layout option with the searchPanes feature name, or the searchPanes buttons, which accepts configuration options as a config parameter.

Types

boolean

Description:

By setting the searchPanes option to true, a series of Panes will be displayed to aid searching the associated DataTable.

This is a short-cut option to enable searchPanes with the default configuration options. Customisations can be made by giving this parameter as an object.

object

Description:

By setting the searchPanes option to an object, SearchPanes will be enabled for the relevant DataTable, with the SearchPanes defaults ($.fn.dataTable.SearchPanes.defaults) extended and overwritten by any conflicting options provided in the object as defined by the programmer.

Default

  • Value: false

The default value for the searchPanes parameter is false. When this default value is in place no panes will be displayed and you will display a standard DataTable along with any other extensions that are in use.

Example

Enable SearchPanes:

new DataTable('#myTable', {
	layout: {
		top1: 'searchPanes'
	}
});