JQuery DataTables的学习笔记整理

jQuery 的插件 dataTables 是一个优秀的表格插件，提供了针对表格的排序、浏览器分页、服务器分页、筛选、格式化等功能。dataTables 的网站上也提供了大量的演示和详细的文档进行说明，为了方便学习使用，这里一步一步进行说明。

项目需要，于是学习整理一波，以便日后开发需要

贴出几个链接：http://blog.csdn.net/llhwin2010/article/details/8663753

http://blog.csdn.net/chengly0129/article/details/6157460  

http://blog.csdn.net/lisky119/article/details/25884197

   

问题：有时提示找不到datatable方法

原因

window.onload必须等到页面内包括图片的所有元素加载完毕后才能执行。 
$(document).ready()是DOM结构绘制完毕后就执行，不必等到加载完毕。

 从后台ajax得数据重建datatables（表单的id要与json的key一致）

一、一些详细配置

1. var docrTable = $('#docrevisontable').dataTable({  
2.             "bProcessing" : true, //DataTables载入数据时，是否显示‘进度’提示  
3.             "bServerSide" : true, //是否启动服务器端数据导入  
4.             "bStateSave" : true, //是否打开客户端状态记录功能,此功能在ajax刷新纪录的时候不会将个性化设定回复为初始化状态  
5.             "bJQueryUI" : true, //是否使用 jQury的UI theme  
6.             "sScrollY" : 450, //DataTables的高  
7.             "sScrollX" : 820, //DataTables的宽  
8.             "aLengthMenu" : [20, 40, 60], //更改显示记录数选项  
9.             "iDisplayLength" : 40, //默认显示的记录数  
10.             "bAutoWidth" : false, //是否自适应宽度  
11.             //"bScrollInfinite" : false, //是否启动初始化滚动条  
12.             "bScrollCollapse" : true, //是否开启DataTables的高度自适应，当数据条数不够分页数据条数的时候，插件高度是否随数据条数而改变  
13.             "bPaginate" : true, //是否显示（应用）分页器  
14.             "bInfo" : true, //是否显示页脚信息，DataTables插件左下角显示记录数  
15.             "sPaginationType" : "full_numbers", //详细分页组，可以支持直接跳转到某页  
16.             "bSort" : true, //是否启动各个字段的排序功能  
17.             "aaSorting" : [[1, "asc"]], //默认的排序方式，第2列，升序排列  
18.             "bFilter" : true, //是否启动过滤、搜索功能  
19.                     "aoColumns" : [{  
20.                         "mDataProp" : "USERID",  
21.                         "sDefaultContent" : "", //此列默认值为""，以防数据中没有此值，DataTables加载数据的时候报错  
22.                         "bVisible" : false //此列不显示  
23.                     }, {  
24.                         "mDataProp" : "USERNAME",  
25.                         "sTitle" : "用户名",  
26.                         "sDefaultContent" : "",  
27.                         "sClass" : "center"  
28.                     }, {  
29.                         "mDataProp" : "EMAIL",  
30.                         "sTitle" : "电子邮箱",  
31.                         "sDefaultContent" : "",  
32.                         "sClass" : "center"  
33.                     }, {  
34.                         "mDataProp" : "MOBILE",  
35.                         "sTitle" : "手机",  
36.                         "sDefaultContent" : "",  
37.                         "sClass" : "center"  
38.                     }, {  
39.                         "mDataProp" : "PHONE",  
40.                         "sTitle" : "座机",  
41.                         "sDefaultContent" : "",  
42.                         "sClass" : "center"  
43.                     }, {  
44.                         "mDataProp" : "NAME",  
45.                         "sTitle" : "姓名",  
46.                         "sDefaultContent" : "",  
47.                         "sClass" : "center"  
48.                     }, {  
49.                         "mDataProp" : "ISADMIN",  
50.                         "sTitle" : "用户权限",  
51.                         "sDefaultContent" : "",  
52.                         "sClass" : "center"  
53.                     }],  
54.                     "oLanguage": { //国际化配置  
55.                 "sProcessing" : "正在获取数据，请稍后...",    
56.                 "sLengthMenu" : "显示 _MENU_ 条",    
57.                 "sZeroRecords" : "没有您要搜索的内容",    
58.                 "sInfo" : "从 _START_ 到  _END_ 条记录 总记录数为 _TOTAL_ 条",    
59.                 "sInfoEmpty" : "记录数为0",    
60.                 "sInfoFiltered" : "(全部记录数 _MAX_ 条)",    
61.                 "sInfoPostFix" : "",    
62.                 "sSearch" : "搜索",    
63.                 "sUrl" : "",    
64.                 "oPaginate": {    
65.                     "sFirst" : "第一页",    
66.                     "sPrevious" : "上一页",    
67.                     "sNext" : "下一页",    
68.                     "sLast" : "最后一页"    
69.                 }  
70.             },  
71.                       
72.                     "fnRowCallback" : function(nRow, aData, iDisplayIndex) {  
73.                         /* 用来改写用户权限的 */  
74.                         if (aData.ISADMIN == '1')  
75.                             $('td:eq(5)', nRow).html('管理员');  
76.                         if (aData.ISADMIN == '2')  
77.                             $('td:eq(5)', nRow).html('资料下载');  
78.                         if (aData.ISADMIN == '3')  
79.                             $('td:eq(5)', nRow).html('一般用户');  
80.                           
81.                         return nRow;  
82.                     },  
83.                       
84.                     "sAjaxSource" : "../use/userList.do?now=" + new Date().getTime(),  
85.                         //服务器端，数据回调处理  
86.                             "fnServerData" : function(sSource, aDataSet, fnCallback) {  
87.                                 $.ajax({  
88.                                     "dataType" : 'json',  
89.                                     "type" : "POST",  
90.                                     "url" : sSource,  
91.                                     "data" : aDataSet,  
92.                                     "success" : fnCallback  
93.                                 });  
94.                             }  
95.                 });  
96.                   
97.                 $("#docrevisontable tbody").click(function(event) { //当点击表格内某一条记录的时候，会将此记录的cId和cName写入到隐藏域中  
98.                     $(docrTable.fnSettings().aoData).each(function() {  
99.                         $(this.nTr).removeClass('row_selected');  
100.                     });  
101.                     $(event.target.parentNode).addClass('row_selected');  
102.                     var aData = docrTable.fnGetData(event.target.parentNode);  
103.                       
104.                     $("#userId").val(aData.USERID);  
105.                     $("#userN").val(aData.USERNAME);  
106.                 });  
107.                   
108.                 $('#docrevisontable_filter').html('<span>用户管理列表');  
109.                 $('#docrevisontable_filter').append('   <input type="button" class="addBtn" id="addBut" value="创建"/>');  
110.                 $('#docrevisontable_filter').append('   <input type="button" class="addBtn" id="addBut" value="修改"/>');  
111.                 $('#docrevisontable_filter').append('   <input type="button" class="addBtn" id="addBut" value="删除"/>');  
112.                 $('#docrevisontable_filter').append('</span>');  
113.         }  

二、数据回调处理

$('#customerInfo').dataTable();

对于从服务器端取数据，还要指定几个参数：
bServerSide：true
sAjaxSource：获取数据的url

这样，在DataTables需要数据时会调用jquery的getJSON获取数据，其中url就
是sAjaxSource，
同时传递一堆自定义的参数，包括需要显示的起始记录数，需要显示的记录数，
列数，排序
列等等，具体可以参看这里http://www.datatables.net/usage/server-side。其中一个比较
特殊的是sEcho，这个参数需要以后原封不动地返回给页面。
由于默认是以$.getJSON发送请求，所以http命令是GET，参数是以url参数的方
式传递的，我
希望以POST命令，以json方式发送请求，而且要加上客户名称这个参数，所以这
里需要做些修
改。
DataTables通过fnServerData提供了这样一个接口，fnServerData是与服务器端交换数据时被
调用的函数，默认实现是如上所说的通过getJSON发送请求，然后接收特定格式的json数据（这
个在服务器端处理部分再说）。fnServerData会接到3个参数：
sSource： 接收数据的url，就是sAjaxSource中指定的地址
aoData：DataTables定义的参数，是一个数组，其中每个元素是一个name-value对，我需要
把客户名称这个参数加进去
fnCallback：服务器返回数据后的处理函数，我需要按DataTables期望的格式传入返回数据
最后自定义的fnServerData如下所示：
javascript代码
function retrieveData( sSource, aoData, fnCallback ) {
//将客户名称加入参数数组,可以添加多条
aoData.push( { "name": "customerName", "value": $("#customerName").val() } );

$.ajax( {
"type": "POST",
"contentType": "application/json",
"url": sSource,
"dataType": "json",//服务器返回的数据类型 可选XML ,Json jsonp script htmlt
"data": JSON.stringify(aoData), //以json格式传递  //经过测试，如果是单独的使用ajax请求，在data里输入key :value格式的代码，则需要将此项删除，否则参数传递不了
"success": function(data) {
fnCallback(data.returnObject); //服务器端返回的对象的returnObject部分是要求的格式
}
});
}

三、

以下是在进行dataTable绑定处理时候可以附加的参数： 

属性名称	取值范围	解释
bAutoWidth	true or false, default true	是否自动计算表格各列宽度
bDeferRender	true or false, default false	用于渲染的一个参数
bFilter	true or false, default true	开关，是否启用客户端过滤功能
bInfo	true or false, default true	开关，是否显示表格的一些信息
bJQueryUI	true or false, default false	是否使用jquery ui themeroller的风格
bLengthChange	true or false, default true	开关，是否显示一个每页长度的选择条（需要分页器支持）
bPaginate	true or false, default true	开关，是否显示（使用）分页器
bProcessing	true or false, defualt false	开关，以指定当正在处理数据的时候，是否显示“正在处理”这个提示信息
bScrollInfinite	true or false, default false	开关，以指定是否无限滚动（与sScrollY配合使用），在大数据量的时候很有用。当这个标志为true的时候，分页器就默认关闭
bSort	true or false, default true	开关，是否让各列具有按列排序功能
bSortClasses	true or false, default true	开关，指定当当前列在排序时，是否增加classes 'sorting_1', 'sorting_2' and 'sorting_3'，打开后，在处理大数据时，性能有所损失
bStateSave	true or false, default false	开关，是否打开客户端状态记录功能。这个数据是记录在cookies中的，打开了这个记录后，即使刷新一次页面，或重新打开浏览器，之前的状态都是保存下来的
sScrollX	'disabled' or  '100%' 类似的字符串	是否开启水平滚动，以及指定滚动区域大小
sScrollY	'disabled' or '200px' 类似的字符串	是否开启垂直滚动，以及指定滚动区域大小
--	--	--
选项
aaSorting	array array[int,string], 如[], [[0,'asc'], [0,'desc']]	指定按多列数据排序的依据
aaSortingFixed	同上	同上。唯一不同点是不能被用户的自定义配置冲突
aLengthMenu	default [10, 25, 50, 100]，可以为一维数组，也可为二维数组，比如：[[10, 25, 50, -1], [10, 25, 50, "All"]]	这个为选择每页的条目数，当使用一个二维数组时，二维层面只能有两个元素，第一个为显示每页条目数的选项，第二个是关于这些选项的解释
aoSearchCols	default null, 类似：[null, {"sSearch": "My filter"}, null,{"sSearch": "^[0-9]", "bEscapeRegex": false}]	给每个列单独定义其初始化搜索列表特性（这一块还没搞懂）
asStripClasses	default ['odd', 'even'], 比如['strip1', 'strip2', 'strip3']	指定要被应用到各行的class风格，会自动循环
bDestroy	true or false, default false	用于当要在同一个元素上执行新的dataTable绑定时，将之前的那个数据对象清除掉，换以新的对象设置
bRetrieve	true or false, default false	用于指明当执行dataTable绑定时，是否返回DataTable对象
bScrollCollapse	true or false, default false	指定适当的时候缩起滚动视图
bSortCellsTop	true or false, default false	（未知的东东）
iCookieDuration	整数，默认7200，单位为秒	指定用于存储客户端信息到cookie中的时间长度，超过这个时间后，自动过期
iDeferLoading	整数，默认为null	延迟加载，它的参数为要加载条目的数目，通常与bServerSide，sAjaxSource等配合使用
iDisplayLength	整数，默认为10	用于指定一屏显示的条数，需开启分页器
iDisplayStart	整数，默认为0	用于指定从哪一条数据开始显示到表格中去
iScrollLoadGap	整数，默认为100	用于指定当DataTable设置为滚动时，最多可以一屏显示多少条数据
oSearch	默认{ "sSearch": "", "bRegex": false, "bSmart": true }	又是初始时指定搜索参数相关的，有点复杂，没搞懂目前
sAjaxDataProp	字符串，default 'aaData'	指定当从服务端获取表格数据时，数据项使用的名字
sAjaxSource	URL字符串，default null	指定要从哪个URL获取数据
sCookiePrefix	字符串，default 'SpryMedia_DataTables_'	当打开状态存储特性后，用于指定存储在cookies中的字符串的前缀名字
sDom	default lfrtip (when bJQueryUI is false) or <"H"lfr>t<"F"ip> (when bJQueryUI is true)	这是用于定义DataTable布局的一个强大的属性，另开专门文档来补充说明吧
sPaginationType	'full_numbers' or 'two_button', default 'two_button'	用于指定分页器风格
sScrollXInner	string default 'disabled'	又是水平滚动相关的，没搞懂啥意思

DataTable支持如下回调函数 

回调函数名称	参数	返回值	默认	功能
fnCookieCallback	1.string: Name of the cookie defined by DataTables 2.object: Data to be stored in the cookie 3.string: Cookie expires string 4.string: Path of the cookie to set	string: cookie formatted string (which should be encoded by using encodeURIComponent())	null	当每次cookies改变时，会触发这个函数调用
fnDrawCallback	无	无	无	在每次table被draw完后调用，至于做什么就看着办吧
fnFooterCallback	1.node : "TR" element for the footer 2.array array strings : Full table data (as derived from the original HTML) 3.int : Index for the current display starting point in the display array< 4.int : Index for the current display ending point in the display array 5.array int : Index array to translate the visual position to the full data array	无	无	用于在每次重画的时候修改表格的脚部
fnFormatNumber	1.int : number to be formatted	String : formatted string for DataTables to show the number	有默认的	用于在大数字上，自动加入一些逗号，分隔开
fnHeaderCallback	1.node : "TR" element for the header 2.array array strings : Full table data (as derived from the original HTML) 3.int : Index for the current display starting point in the display array 4.int : Index for the current display ending point in the display array 5.array int : Index array to translate the visual position to the full data array	无	无	用于在每次draw发生时，修改table的header
fnInfoCallback	1.object: DataTables settings object 2.int: Starting position in data for the draw 3.int: End position in data for the draw 4.int: Total number of rows in the table (regardless of filtering) 5.int: Total number of rows in the data set, after filtering 6.string: The string that DataTables has formatted using it's own rules	string: The string to be displayed in the information element.	无	用于传达table信息
fnInitComplete	1.object:oSettings - DataTables settings object	无	无	表格初始化完成后调用
fnPreDrawCallback	1.object:oSettings - DataTables settings object	Boolean	无	用于在开始绘制之前调用，返回false的话，会阻止draw事件发生；返回其它值，draw可以顺利执行
fnRowCallback	1.node : "TR" element for the current row 2.array strings : Raw data array for this row (as derived from the original HTML) 3.int : The display index for the current table draw 4.int : The index of the data in the full list of rows (after filtering)	node : "TR" element for the current row	无	当创建了行，但还未绘制到屏幕上的时候调用，通常用于改变行的class风格
fnServerData	1.string: HTTP source to obtain the data from (i.e. sAjaxSource) 2.array objects: A key/value pair object containing the data to send to the server 3.function: Function to be called on completion of the data get process that will draw the data on the page.	void	$.getJSON	用于替换默认发到服务端的请求操作
fnStateLoadCallback	1.object:oSettings - DataTables settings object 2.object:oData - Object containing information retrieved from the state saving cookie which should be restored. For the exact properties please refer to the DataTables code.	Boolean - false if the state should not be loaded, true otherwise	无	在cookies中的数据被加载前执行，可以方便地修改这些数据
fnStateSaveCallback	1.object:oSettings - DataTables settings object 2.String:sValue - a JSON string (without the final closing brace) which should be stored in the state saving cookie.	String - the full string that should be used to save the state	无	在状态数据被存储到cookies前执行，可以方便地做一些预操作

• bPaginate: 是否分页，默认为 true，分页
• iDisplayLength : 每页的行数，每页默认数量:10
• sPaginationType: 分页样式，支持两种内置方式，two_button 和 full_numbers, 默认使用 two_button。
• bLengthChange : 是否允许用户通过一个下拉列表来选择分页后每页的行数。行数为 10，25，50，100。这个设置需要 bPaginate 支持。默认为 true。
• bFilter: 启用或禁止数据过滤，默认为 true。 注意，如果使用过滤功能，但是希望关闭默认的过滤输入框，应使用 sDom
• bInfo: 允许或者禁止表信息的显示，默认为 true，显示信息。