jQuery Datatable in MVC … extended.
- by Steve Clements
There are a million plugins for jQuery and when a web forms developer like myself works in MVC making use of them is par-for-the-course! MVC is the way now, web forms are but a memory!! Grids / tables are my focus at the moment. I don’t want to get in to righting reems of css and html, but it’s not acceptable to simply dump a table on the screen, functionality like sorting, paging, fixed header and perhaps filtering are expected behaviour. What isn’t always required though is the massive functionality like editing etc you get with many grid plugins out there. You potentially spend a long time getting everything hooked together when you just don’t need it. That is where the jQuery DataTable plugin comes in. It doesn’t have editing “out of the box” (you can add other plugins as you require to achieve such functionality). What it does though is very nicely format a table (and integrate with jQuery UI) without needing to hook up and Async actions etc. Take a look here… http://www.datatables.net I did in the first instance start looking at the Telerik MVC grid control – I’m a fan of Telerik controls and if you are developing an in-house of open source app you get the MVC stuff for free…nice! Their grid however is far more than I require. Note: Using Telerik MVC controls with your own jQuery and jQuery UI does come with some hurdles, mainly to do with the order in which all your jQuery is executing – I won’t cover that here though – mainly because I don’t have a clear answer on the best way to solve it! One nice thing about the dataTable above is how easy it is to extend http://www.datatables.net/examples/plug-ins/plugin_api.html and there are some nifty examples on the site already… I however have a requirement that wasn’t on the site … I need a grid at the bottom of the page that will size automatically to the bottom of the page and be scrollable if required within its own space i.e. everything above the grid didn’t scroll as well. Now a CSS master may have a great solution to this … I’m not that master and so didn’t! The content above the grid can vary so any kind of fixed positioning is out. So I wrote a little extension for the DataTable, hooked that up to the document.ready event and window.resize event. Initialising my dataTable ( s )… $(document).ready(function () {
var dTable = $(".tdata").dataTable({
"bPaginate": false,
"bLengthChange": false,
"bFilter": true,
"bSort": true,
"bInfo": false,
"bAutoWidth": true,
"sScrollY": "400px"
});
My extension to the API to give me the resizing….
// **********************************************************************
// jQuery dataTable API extension to resize grid and adjust column sizes
//
$.fn.dataTableExt.oApi.fnSetHeightToBottom = function (oSettings) {
var id = oSettings.nTable.id;
var dt = $("#" + id);
var top = dt.position().top;
var winHeight = $(document).height();
var remain = (winHeight - top) - 83;
dt.parent().attr("style", "overflow-x: auto; overflow-y: auto; height: " + remain + "px;");
this.fnAdjustColumnSizing();
}
This is very much is debug mode, so pretty verbose at the moment – I’ll tidy that up later!
You can see the last call is a call to an existing method, as the columns are fixed and that normally involves so CSS voodoo, a call to adjust those sizes is required.
Just above is the style that the dataTable gives the grid wrapper div, I got that from some firebug action and stick in my new height.
The –83 is to give me the space at the bottom i require for fixed footer!
Finally I hook that up to the load and window resize. I’m actually using jQuery UI tabs as well, so I’ve got that in the open event of the tabs.
$(document).ready(function () {
var oTable;
$("#tabs").tabs({
"show": function (event, ui) {
oTable = $('div.dataTables_scrollBody>table.tdata', ui.panel).dataTable();
if (oTable.length > 0) {
oTable.fnSetHeightToBottom();
}
}
});
$(window).bind("resize", function () {
oTable.fnSetHeightToBottom();
});
});
And that all there is too it. Testament to the wonders of jQuery and the immense community surrounding it – to which I am extremely grateful.
I’ve also hooked up some custom column filtering on the grid – pretty normal stuff though – you can get what you need for that from their website. I do hide the out of the box filter input as I wanted column specific, you need filtering turned on when initialising to get it to work and that input come with it! Tip: fnFilter is the method you want. With column index as a param – I used data tags to simply that one.
