fnMultiFilter

Apply multiple column filters together

  • Author: mrkevans
  • Deprecated: This plug-in has been deprecated and replaced with other functionality. Please see the detailed description below for more information.

This plug-in adds to DataTables the ability to set multiple column filtering terms in a single call (particularly useful if using server-side processing). Used in combination with the column sName parameter, simply pass in an object with the key/value pair being the column you wish to search on, and the value you wish to search for.

DataTables 1.10's API provides a easy built-in way to apply multiple filters to the table without redrawing until required. For example, the example below with the DataTables 1.10 API could be written as:

var table = $('#example').DataTable();
table
 .column( 0 ).search( 'Gecko' )
 .column( 1 ).search( 'Cam' )
 .draw();

As such this method is marked deprecated, but is available for use with legacy version of DataTables. Please use the new API if you are used DataTables 1.10 or newer.

Use

This plug-in can be obtained and used in multiple different ways.

Browser

This plug-in is available on the DataTables CDN:

JS

The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.

Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.

NPM

The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins package. To use this plug-in, first install the plug-ins package:

npm install datatables.net-plugins

ES modules

Then, if you are using ES modules, import datatables.net, any other DataTables extensions you need, and the plug-in:

import DataTable from 'datatables.net';
import 'datatables.net-plugins/api/fnMultiFilter.mjs';

CommonJS

If you are using a CommonJS loader for Node (e.g. with older versions of Webpack, or non-module Node code) use the following method to require the plug-in:

var $ = require('jquery');
var DataTable = require('datatables.net');
require('datatables.net-plugins/api/fnMultiFilter.js');

Example

$(document).ready(function() {
      var table = $('#example').dataTable( {
          "aoColumns": [
              { "sName": "engine" },
              { "sName": "browser" },
              { "sName": "platform" },
              { "sName": "version" },
              { "sName": "grade" }
          ]
      } );
      table.fnMultiFilter( { "engine": "Gecko", "browser": "Cam" } );
  } );

Version control

If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!