Preamble

There may be occasions when you wish to filter data presented to the end user in your own manner, common examples are number range filtering (in between two numbers) and date range filtering. DataTables provide an API method to add your own filtering functions, $.fn.dataTableExt.afnFiltering. This is an array of functions (push your own onto it) which will will be run at table draw time to see if a particular row should be included or not.

Live example

Minimum engine version:
Maximum engine version:

Initialisation code

/* Custom filtering function which will filter data in column four between two values */
$.fn.dataTableExt.afnFiltering.push(
	function( oSettings, aData, iDataIndex ) {
		var iMin = document.getElementById('min').value * 1;
		var iMax = document.getElementById('max').value * 1;
		var iVersion = aData[3] == "-" ? 0 : aData[3]*1;
		if ( iMin == "" && iMax == "" )
		{
			return true;
		}
		else if ( iMin == "" && iVersion < iMax )
		{
			return true;
		}
		else if ( iMin < iVersion && "" == iMax )
		{
			return true;
		}
		else if ( iMin < iVersion && iVersion < iMax )
		{
			return true;
		}
		return false;
	}
);

$(document).ready(function() {
	/* Initialise datatables */
	var oTable = $('#example').dataTable();
	
	/* Add event listeners to the two range filtering inputs */
	$('#min').keyup( function() { oTable.fnDraw(); } );
	$('#max').keyup( function() { oTable.fnDraw(); } );
} );

Other examples

Basic initialisation

• Zero configuration
• Feature enablement
• Sorting data
• Multi-column sorting
• Multiple tables
• Hidden columns
• DOM positioning
• State saving
• Alternative pagination styles
• Change language information (internationalisation)
• ThemeRoller themes (Smoothness)

Advanced initialisation

• Events (pre initialisation)
• Events (post initialisation)
• Column rendering
• Sorting without HTML tags
• Multiple table controls (sDom)
• Custom toolbar (element) around table
• Set sorting controls
• Column grouping through col/row spans
• Row grouping
• Row callback
• Footer callback
• Change language information from a file (internationalisation)

Data sources

• DOM
• Javascript array
• Ajax source
• Server side processing

Server-side processing

• Obtain server-side data
• Add extra HTTP variables
• Use HTTP POST
• Custom column ordering (in callback data)
• Pipelining data (reduce Ajax calls for paging)
• Show and hide details about a particular record
• User selectable rows (multiple rows)

API

• Dynamically add a new row
• Individual column filtering
• Highlight rows and columns
• Show and hide details about a particular record
• User selectable rows (multiple rows)
• User selectable rows (single row) and delete rows
• Editable rows (with jEditable)
• Submit form with elements in table
• Index column (static number column)
• Show and hide columns dynamically
• Regular expression filtering

Plug-ins

• Add custom API functions
• Sorting and type detection
• Custom pagination controls
• Range filtering / custom filtering
• Live DOM sorting

Please refer to the DataTables documentation for full information about its API properties and methods.