前端常用功能记录(二)—datatables表格

　　并不是所有的后台开发都有美工和前端工程师来配合做页面，为了显示数据并有一定的美感，jQuery的DataTables插件对于像我这样的前端菜鸟来说真是雪中送炭，当然对于专业的前端开发者来说它更是锦上添花！DataTables提供了针对表格的排序、浏览器分页、服务器分页、筛选、格式化、统计等强大功能。

　　工作中对程序员的学习模式才深有体会，不是从入门到精通，而是从会用到了解。对于我来说，基本都是拿到一个知识先做个东西出来，再来细细品味个中的细节，然后再慢慢理解。从粗到细，从大到小，呵呵，这种"逆向学习"的模式估计也只在互联网常见了。

 

 使用前要引入datatables的相关包：

<script src="//code.jquery.com/jquery-1.11.1.min.js"></script>
<script src="//cdn.datatables.net/1.10.4/js/jquery.dataTables.min.js"></script>

datatables表格展示以及数据源方式都有很多，这里用的是最常见的后端返回给前端的json格式的数据源，并且前端html里指定列的title。

后端的数据可以如下：

app.get(‘/test/index‘, function(req, res) {
    var  data = [{name:‘xiaojie‘,age:24,job:‘developer‘,description:‘humours‘},{},{},{}]; //格式像这样,数据省略
    res.json({data:data});

});

html里仅仅声明一个table的框架：

<table class="table b-t b-light"  id="datatables">
      <thead>
        <tr>
          <th>姓名</th>
          <th>年龄</th>
          <th>JOB</th>
          <th>描述</th>
　　　　　  <th>操作</th>  <!--自定义列-->
        </tr>
      </thead>
      <tbody>
      </tbody>
</table>

重头戏是js，这里有功能强大的字段，待我慢慢道来。

首先初始化一个datatables，最基本的就这样：

$(document).ready(function() {
    $(‘#datatables‘).dataTable( {

    } );
} );

datatables太强大，记录起来真是无处下手。 先来看个例子，然后再做详细介绍：

<script type="text/javascript">
$(document).ready(function() {
    var table = $(‘#datatables‘).DataTable({
        "autoWidth": false,
        "paging": true,
        //"dom": ‘T<"clear"><"toolbar">Clfrtip‘,
        "dom": ‘iCflrtp‘,
        "iDisplayLength": 100,
        "lengthMenu": [[100, 500, 1000, -1], [100, 500, 1000, "所有"]],
        "tableTools": {
            "sSwfPath": "/js/datatables/tabletools/swf/copy_csv_xls_pdf.swf",
            "aButtons": [
                 {sExtends: "csv", oSelectorOpts: {page: "current" }},
                 "print"],
            "sRowSelect": "os",
        },
        "stateSave": false,
        "processing": true,
        "ajax": {
            ‘url‘: "/test/index",
        },
        "order": [
                [0, "asc"], 
                [1, "asc"], 
                [2, "desc"],
            ],
        "columnDefs": [
              {width: ‘25%‘, targets: 3},
            ],
        "columns": [{
            "data": "name",
        }, {
            "data": "age",
        }, {
            "data": "job",
        }, {
            "data": "description",
            "visible":false
        }],
        "sPaginationType": "full_numbers",
        "oLanguage": {
            "sProcessing": "<img src=‘/images/datatable_loading.gif‘>  努力加载数据中.",
            "sLengthMenu": "每页显示 _MENU_ 条记录",
            "sZeroRecords": "抱歉， 没有找到",
            "sInfo": "从 _START_ 到 _END_ /共 _TOTAL_ 条数据",
            "sInfoEmpty": "没有数据",
            "sInfoFiltered": "(从 _MAX_ 条数据中检索)",
            "sZeroRecords": "没有检索到数据",
            "sSearch": "模糊查询:  ",
            "oPaginate": {
                "sFirst": "首页",
                "sPrevious": "前一页",
                "sNext": "后一页",
                "sLast": "尾页"
            }
        },
    });

这里面每个字段都可以说上一番，有些简单很容易理解，像dom这种就很复杂。

展示的效果表格前面：

表格底部是分页：

 

 

然后说明一下每个字段的效果都体现在哪里

autoWidth

用来启用或禁用自动列的宽度计算。通常被禁用作为优化（它需要一个有限的时间量来计算的宽度），默认值是true，所以通常将它设为false

分页paging

指定它才能显示表格底部的分页按钮，如果数据量大的话，这个通常需要设置为true，当然它也与dom的值息息相关，如果dom中没有指定p这个字符，它即使为true也是无效的。

dom

这个是我认为最复杂也是功能最强大的字段，当然目前我也只用到了它的冰山一角。

当自定义数据表时，可以根据自身喜好来设置功能元素的默认位置等，可以指定容器，由数据表给出每个HTML控制元件被表示为在domDT选项的单个字符。

dom常用的初始化字符如下：

l - Length changing  选择每页显示行数下拉框的控件
f - Filtering input  搜索过滤控件
t - The Tabletools    导出excel，csv的按钮
i - Information  显示汇总信息（从 1 到 100 /共 1,288 条数据）
p - Pagination   分页控件
r - pRocessing   显示加载时的进度条
C - copy 显示复制，excel的控件

下面四种是在dom中在自定义的位置植入自定义元素和class

< and > - DIV元素
<"class" and > - DIV和Class
<"#id" and > - DIV和ID
<"#id.class" and > - DIV 和ID 和Class

这些元素的先后顺序也决定了对应的控件在表格中显示的位置。举个例子：

"dom": ‘i<"toolbar">TCflrtp‘, 则在汇总信息(i)左边定义了一个div:toolbar

js如下：

$("div.toolbar").html("<button class=‘btn btn-primary add_server‘ ><span>自定义按钮</span></button>");
        $(".add_server").click(function(){
          location.href ="/server/import"
})

即这是在汇总信息左边会出现一个按钮，点击跳转到另一个页面。这种方式可以在一个集成的表格里植入自定义的东西，非常赞！

对于改变页面上元素的位置，我还愿意多举几个例子：

example 1: 简单的DIV和样式元素设置

/* Results in: 
    <div class="wrapper"> 
      {filter} 
      {length} 
      {information} 
      {pagination} 
      {table} 
    </div> 
*/  
$(‘#example‘).dataTable( {  
  "dom": ‘<"wrapper"flipt>‘  
} );  

example 2: 每页行数p，检索条件f，分页p在表格上面，表信息i在表格下面

/* Results in: 
    <div> 
      {length} 
      {filter} 
      <div> 
        {table} 
      </div> 
      {information} 
      {pagination} 
    </div> 
*/  
$(‘#example‘).dataTable( {  
  "dom": ‘<lf<t>ip>‘  
} ); 

example 3: 表信息i在表上面，检索条件f，每页行数p，处理中r在表下面，并且有清除元素

/* Results in: 
    <div class="top"> 
      {information} 
    </div> 
    {processing} 
    {table} 
    <div class="bottom"> 
      {filter} 
      {length} 
      {pagination} 
    </div> 
    <div class="clear"></div> 
*/  
$(‘#example‘).dataTable( {  
  "dom": ‘<"top"i>rt<"bottom"flp><"clear">‘  
} );

iDisplayLength和lengthMenu

这两个元素是和dom的l字符对应的，

"iDisplayLength": 100,   ------表示默认1页是100行数据

"lengthMenu": [[100, 500, 1000, -1], [100, 500, 1000, "所有"]],  -------自定义每页显示的行数，

iDisplayLength默认是10行，lengthMenu默认是[[10 25 50 100], [10 25 50 100]]

tableTools

这个也有很多参数，这里只写了常见的。swf可以导出为csv,pdf,xls三种文件，若需要一种，可以在aButtons中指定

"tableTools": {
   "sSwfPath": "/js/datatables/tabletools/swf/copy_csv_xls_pdf.swf",
   "aButtons": [
      {sExtends: "csv", oSelectorOpts: {page: "current" },sFileName: "test.csv", //导出为csv文件，并且指定了文件的名称
      },
      "print", //打印控件
      "sRowSelect": "os",
},

对应的表格控件为：

stateSave

如果设置为true这个是保存当前用户的状态的，比如用户选择当前每页显示500行，那么他重新刷页面这个不是默认的100行，而是记录了用户的行为显示500行。

processing

这个对应dom中的r，即加载数据时显示的进度，这个一般都设置为true，不然数据量大的话用户可能等上几秒却不知怎么回事，显示的控件如下：

ajax

即后端传来的数据，如果按照上述传来的数据格式的话，则下面的url就是后端指定的url:

 "ajax": {
            ‘url‘: "/test/index",
        },

order

排序，这个可以对单列排序，可以按照指定的顺序，先按哪列排序再按哪列排序

 

"order": [
                [0, "asc"], 
                [1, "asc"], 
                [2, "desc"],
            ],
//表示先对第1列进行升序排序，再按照第二列升序排序，最后按照第三列降序排序

 

columnDefs

这个字段可以对列进行很多操作，这个字段也很复杂，功能强大

 "columnDefs": [
              {width: ‘25%‘, targets: 3},
            ],

上面举的例子的意思是对第四列的宽度设置占所有列宽度的25%，它还有很强大的功能，如改变某列元素的属性，增加列等，如下：

 "columnDefs": [
                  // 将name列变为红色
                  {
                      "targets": [0], // 目标列位置，下标从0开始
                      "data": "name", // 数据列名
                      "render": function(data, type, full) { // 返回自定义内容
                          return "<span style=‘color:red;‘>" + data + "</span>";
                      }
                  },
                  // 增加一列，包括删除和修改，同时将需要传递的数据传递到链接中
                  {
                      "targets": [4], // 目标列位置，下标从0开始
                      "data": "name", // 数据列名
                      "render": function(data, type, full) { // 返回自定义内容
                          return "<a href=‘/delete?name=" + data + "‘>删除</a>&nbsp;<a href=‘/update?name=" + data + "‘>更新</a>";
                      }
                  }
              ]

columns
这个指定了传过来的数据的字段，visible字段默认是true，如果设置false的话，显示的时候是隐藏的，当然也可以通过空间取消其隐藏。

sPaginationType (pagingType)

sPaginationType: 分页样式，支持四种内置方式，simple、simple_numbers、full和 full_numbers, 默认使用 simple_numbers。即下面四种方式：

simple: ‘Previous‘ and ‘Next‘ buttons only

simple_numbers: ‘Previous‘ and ‘Next‘ buttons, plus page numbers

 

full: ‘First‘, ‘Previous‘, ‘Next‘ and ‘Last‘ buttons

full_numbers: ‘First‘, ‘Previous‘, ‘Next‘ and ‘Last‘ buttons, plus page numbers

oLanguage

数据表的语言设置，默认都是英文的，可以通过修改下面源码的字段来修改成中文，更可以改为喜欢的展现方式。

另外有点想说明下，开始对于这些个字段的命名不太理解，原来第一个小写字母表示它接受参数的类型。

a: array   s:string   o:object

   "oLanguage": {
            "sProcessing": "<img src=‘/images/datatable_loading.gif‘>  努力加载数据中.",
            "sLengthMenu": "每页显示 _MENU_ 条记录",
            "sZeroRecords": "抱歉， 没有找到",
            "sInfo": "从 _START_ 到 _END_ /共 _TOTAL_ 条数据",
            "sInfoEmpty": "没有数据",
            "sInfoFiltered": "(从 _MAX_ 条数据中检索)",
            "sZeroRecords": "没有检索到数据",
            "sSearch": "模糊查询:  ",
            "oPaginate": {
                "sFirst": "首页",
                "sPrevious": "前一页",
                "sNext": "后一页",
                "sLast": "尾页"
            }
        },

rowCallback

还有一个常用的是rowCallback，当创建了行，但还未绘制到屏幕上的时候调用，通常用于改变行的class风格。比如为列为IP的这一行加个超链接，代码接着上面的：

"rowCallback": function(row, data) { //data是后端返回的数据
    if(data.ip) {
      $(‘td:eq(3)‘, row).html(‘<a target="_blank" href=http://‘ + data.ip + ‘>‘ + data.ip + ‘</a>‘);
    }
},

//$(‘td:eq(3)‘, row)表示选中第四列的元素

则这样的话第四列的IP只要不为空值则都链接到自己的页面。

 

datatables实在太强大，太方便，我这里说的仍然是冰山一角，下面附录是摘自网上，常用的属性和方法

要注意的是，要被dataTable处理的table对象，必须有thead与tbody，而且，结构要规整（数据不一定要完整），这样才能正确处理。

 

以下是在进行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前执行，可以方便地做一些预操作

 

from http://www.cnblogs.com/zhoujie