columns().search.fixed()

Since: DataTables 2.0

Get / set a named search to apply to a column.

Description

Just as search.fixed() applies a "fixed" search term to the whole table, this method can be used to apply a search term to a specific column.

The fixed search (which might also be termed sticky or named searches) provides a way to easily add cumulative search terms to the table. You can add multiple independent search terms, and DataTables will combine them (AND logic) displaying the result of all search terms that have been applied.

Please be aware that this method sets the fixed search to apply to the columns only - it does not actually perform the search. In order to have the search performed and the result shown, use the draw() method, which can be called simply as a chained method of this method.

When using server-side processing, additional logic must be added at the server-side to handle fixed search terms. Additionally, searching by functions is not possible, since the search function is client-side based.

Types

function columns().search.fixed()

Description:: Get a list of the names of searches applied to the selected columns.
Returns:: DataTables.Api

An API instance that contains the names of the search terms applied to the columns.

function columns().search.fixed( name )

Description:: Get the search term used for the given name.
Returns:: undefined, function, string, RegExp

The search term that was originally applied.

function columns().search.fixed( name, searchTerm )

Description:

Parameters:

	Name	Type	Optional
1	`name`	`string`	No
	Treat as a regular expression (`true`) or not (default, `false`).
2	`input`	`string`, `RegExp`, `function`, `null`	No
	The search term to apply to the table. Use `null` for this value to delete an existing search term. If given as a string, it will be applied to the table's search using DataTables "smart" search (see `search()`). If working with a regular expression, the data given is the search data for the cells in column in question. In the case of a function the function is called for each row with two parameters which are passed in; the first is the search data for the cell in the row/column being search, and the second is the row's original data object. A boolean value should be returned: `true` to keep the row, `false` to filter it out.

Returns:

DataTables.Api

DataTables API instance

Examples

Get an array of current search names from all columns:

let table = new DataTable('#myTable');

let searches = table
	.columns()
	.search.fixed()
	.toArray();

Get an expecting search term:

let search = table.columns([1, 4]).search.fixed('mySearch');

Applying a search string:

table.columns('.cities').search.fixed('myString', 'Paris');

Applying a search regex to column indexes 0 and 1:

table.columns([0, 1]).search.fixed('myRegex', /l.*n/i);

Applying a search function to multiple columns:

table.columns('.number').search.fixed('myFunc', (cell, data) => {
	return cell > 50;
});

Deleting an existing search term from all columns:

table.columns().search.fixed('mySearch', null);

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

API

Options