searchBuilder

Since: SearchBuilder 1.0.0

Enable and configure the SearchBuilder extension for DataTables.
Please note - this property requires the SearchBuilder extension for DataTables.

Description

SearchBuilder is an extension that presents a user interface for building complex search operations, including grouping logic.

SearchBuilder can be enabled through the layout option with the searchBuilder feature name, or the searchBuilder button, which accepts configuration options as a config parameter.

Please see the Related section below for a list of all configuration options available for SearchBuilder.

Type

object

Description:: If given as an object, SearchBuilder will be enabled on the target DataTable with the SearchBuilder defaults (DataTable.SearchBuilder.defaults) extended, and potentially overwritten by the options provided in this object. This is how SearchBuilder can be configured on an individual table basis, or through the defaults.

Examples

Enable SearchBuilder for a table using the dom option:

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

Enable SearchBuilder with configuration options:

new DataTable('#myTable', {
	layout: {
		top1: {
			searchBuilder: {
				depthLimit: 2
			}
		}
	}
});

The following options are directly related and may also be useful in your application development.

Options