fnFilterClear

Remove all column and global filters applied to a table

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

Remove all filtering that has been applied to a DataTable, be it column based filtering or global filtering.

DataTables 1.10+ new API can achieve the same effect as this plug-in, without the requirement for plug-ins using the following chaining:

var table = $('#example').DataTable();
table
 .search( '' )
 .columns().search( '' )
 .draw();

Please use the new API in DataTables 1.10+ is you are able to do so.

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/fnFilterClear.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/fnFilterClear.js');

Example

$(document).ready(function() {
      var table = $('#example').dataTable();

      // Perform a filter
      table.fnFilter('Win');
      table.fnFilter('Trident', 0);

      // Remove all filtering
      table.fnFilterClear();
  } );

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!