{hero}

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

This option is an alias to searchBuilder, which should be preferred when using DataTables 2+. It can be used to configure SearchBuilder regardless of how the panes are inserted into the document (layout or searchBuilder).

Please refer to the documentation for searchBuilder for full details of this option.

Type

object

Description:

If given as an object, SearchBuilder will be enabled on the target DataTable with the SearchBuilder defaults ($.fn.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'
	},
	searchBuilder: {
		depthLimit: 2
	}
});