datatable 属性介绍

r囧r小猫 2021-10-08 07:32 376阅读 0赞

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

<table> 
 <tbody> 
  <tr> 
   <td colspan="3">对于服务器来说，可以通过请求参数来获得当前的操作信息。[也就是说以下这个列表中的属性值都是可以在服务器端的方法中获取到！]</td> 
  </tr> 
  <tr> 
   <td>类型</td> 
   <td>名称</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iDisplayStart</td> 
   <td>显示的起始索引</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iDisplayLength</td> 
   <td>显示的行数</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iColumns</td> 
   <td>显示的列数&nbsp;</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sSearch</td> 
   <td>全局搜索字段&nbsp;</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>bEscapeRegex</td> 
   <td>全局搜索是否正则</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>bSortable_(int)</td> 
   <td>表示一列是否在客户端被标志位可排序</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>bSearchable_(int)</td> 
   <td>表示一列是否在客户端被标志位可搜索</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sSearch_(int)</td> 
   <td>个别列的搜索</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>bEscapeRegex_(int)</td> 
   <td>个别列是否使用正则搜索</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iSortingCols&nbsp;</td> 
   <td>排序的列数&nbsp;</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iSortCol_(int)</td> 
   <td>被排序的列</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sSortDir_(int)</td> 
   <td>排序的方向&nbsp;"desc"&nbsp;或者&nbsp;"asc".&nbsp;</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sEcho</td> 
   <td>DataTables&nbsp;用来生成的信息</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <td colspan="3">服务器返回的数据格式如下所示</td> 
  </tr> 
  <tr> 
   <td>类型</td> 
   <td>名称</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iTotalRecords</td> 
   <td>实际的行数</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>iTotalDisplayRecords</td> 
   <td>过滤之后，实际的行数。</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sEcho</td> 
   <td>来自客户端&nbsp;sEcho&nbsp;的没有变化的复制品，</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>sColumns</td> 
   <td>可选，以逗号分隔的列名，&nbsp;</td> 
  </tr> 
  <tr> 
   <td>array&nbsp;array&nbsp;mixed</td> 
   <td>aaData</td> 
   <td>数组的数组，表格中的实际数据。&nbsp;</td> 
  </tr> 
 </tbody> 
</table>