Click here to Skip to main content
13,259,194 members (49,387 online)
Click here to Skip to main content
Add your own
alternative version

Stats

15.1K views
356 downloads
8 bookmarked
Posted 28 Oct 2011

Extending DataTables Range Filter

, 28 Oct 2011
Rate this:
Please Sign up or sign in to vote.
DataTables plugin extension to include range filter

Introduction

DataTables plugin provides a very efficient and easier way to integrate grid style view on the client-side using basic HTML and JavaScript. Using this plugin, you can produce output similar to this with very few lines of code:

Click to enlarge image

Background

Best thing is that you get the sort and filtering very easily using this plugin. We can filter with a text box or even a select box. We can even filter on the range like the above image shows. I had a special requirement for which I need to have select boxes in the range type of column. So I need to change the plug-in. I have updated the plugin for that matter so that I can have select boxes in the range type of field to.

Using the Code

In order to achieve this functionality, I have done the following:

Step 1

The first change I has to make in jquery.dataTables.columnFilter.js was to update the fnCreateRangeInput method. I included two parameters which tell the kind of the range filter (text box or select drop down) & the second parameter to provide the values in case it is a select box. The following is the code update in fnCreateRangeInput method:

/* 	Customized code which can filter data with the select columns between two values
*	Updated By: 	Muhammad Waseem Arfi
*/

if(oSelect == "")
{
	from = $('<input type="text" rel="' + i + '" id="' + 
	  sFromId + '" class="number_range_filter" />');
}
else
{
	from = '<select rel="' + i + '" id="' + sFromId + 
	  '" class="number_range_filter"><option value="'+
	  aData[0]+'">ALL</option>';

	var j = 0;
	var iLen = aData.length;
	for (j = 0; j < iLen; j++) 
	{
		if (typeof (aData[j]) != 'object') 
		{
			from += '<option value="' + escape(aData[j]) + 
			        '">' + aData[j] + '</option>';
		}
		else 
		{
			from += '<option value="' + escape(aData[j].value) + 
			        '">' + aData[j].label + '</option>';
		}
	}
	from += '</select>';
}

th.append(from);
th.append(_fnRangeLabelPart(1));
var sToId = oTable.attr("id") + '_range_to_' + i;
if(oSelect == "")
{
	to = $('<input type="text" rel="' + i + '" id="' + 
	       sToId + '" class="number_range_filter" />');
}
else
{
	to = '<select rel="' + i + '" id="' + sToId + 
	     '" class="number_range_filter"><option value="'+ 
	     aData[aData.length-1] +'">ALL</option>';
	var j = 0;
	var iLen = aData.length;
	for (j = 0; j < iLen; j++) 
	{
		if (typeof (aData[j]) != 'object') 
		{
			to += '<option value="' + escape(aData[j]) + 
			      '">' + aData[j] + '</option>';
		}
		else 
		{
			to += '<option value="' + escape(aData[j].value) + 
			      '">' + aData[j].label + '</option>';
		}
	}
	to += '</select>';
}
	
/* Code update ends here */

I have included the code in the method for adding select box. In the “From” select box, the default option will be the first value in the array which is passed, whereas the “To” will have the last one.

Step 2

Then I updated the case statements in the main method, the changes are shown below:

case "number-range":
    fnCreateRangeInput(oTable,"","");
    break;
case "number-range-select":
    fnCreateRangeInput(oTable, "select",aoColumn.values);
    break;

Step 3

Once it is done, it will be very easy to use the new type for range filter, this is how the JavaScript will be written in order to call this method:

$('#example').dataTable({"bFilter": true, 
  "bDisplayLength":false  }).columnFilter({ sPlaceHolder: "head:after", 
  aoColumns: [{ type: "select" }, {type: "select" },
  { type: "number-range-select",values: [ "10", "50", "100"]}]});

The third line shows the use of the new field type named ‘number-range-select’. Once we write this code, this is how the range column filter will look like:

Click to enlarge image

History

  • 28th October, 2011: Initial post

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Muhammad Waseem Arfi
Architect Al Taqnyah Business Solutions
United Arab Emirates United Arab Emirates
Working as Senior Consultant SharePoint. Design, Architect, Develop and Advise SharePoint Solutions

You may also be interested in...

Comments and Discussions

 
-- There are no messages in this forum --
Permalink | Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.171114.1 | Last Updated 28 Oct 2011
Article Copyright 2011 by Muhammad Waseem Arfi
Everything else Copyright © CodeProject, 1999-2017
Layout: fixed | fluid