datatable 基本参数

朱雀 2022-08-23 00:38 196阅读 0赞

转 Datatables中文API——基本参数

鉴于自己一直在使用datatables，发现这是个很不错的表格插件，但是好的东西都是英文的，所以我结合自己的使用经验，把官网的英文api做下简单的翻译，同时也希望大家把自己的使用经验一起分享出来，让我们更好的使用datatables，本帖将会持续更新……  
从基本属性开始吧  
bAutoWidth ：启用或禁用自动列宽度的计算。

默认值

true

类型

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bAutoWidth”: false //关闭后，表格将不会自动计算表格大小，在浏览器大化小化的时候会挤在一坨
3.  \} );

5.\} );  
复制代码  
bDeferRender ：根据官网的介绍翻译过来就是，延期渲染，可以有个速度的提升，当datatable 使用Ajax或者JS源表的数据。这个选项设置为true,将导致datatable推迟创建表元素每个元素,直到他们都创建完成——本参数的目的是节省大量的时间。

默认值：

false

类型：

boolean

1.$(document).ready( function() \{

1.  var oTable = $(‘\#example’).dataTable( \{
2.  “sAjaxSource”: “sources/arrays.txt”,
3.  “bDeferRender”: true //这个参数我个人没有使用过，到底是不是这个效果，大家自己去尝试一下
4.  \} );

6.\} );  
复制代码  
bFilter：这个很容易明白，启用或禁用过滤数据。在datatable过滤是“智能”,它允许用户 最终输入多个关键字(空格分隔)，和每一行数据匹配,即使不是在被指定的顺序(这允许匹配多个列)。注意,如果您希望使用过滤，在datatable中必 须设置为true，如果要删除默认过滤输入框和留住过滤功能,请使用\{ @link DataTable.defaults.sDom \}。这个最后一句不明白，不知道大家怎么理解。

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bFilter”: false
3.  \} );

5.\} );  
复制代码  
bJQueryUI ：这个不用多说了，一看就懂，启用jQuery UI样式，(需要在页面添加jQuery的样式文件)。

默认值：

false

类型：

boolean

1.$(document).ready( function() \{

1.  $(‘\#example’).dataTable( \{
2.  “bJQueryUI”: true
3.  \} );

5.\} );  
复制代码  
bLengthChange ：开启一页显示多少条数据的下拉菜单，允许用户从下拉框(10、25、50和100)，注意需要分页(bPaginate：true)。

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bLengthChange”: false,  
    复制代码  
    bPaginate ：开启分页功能，如果不开启，将会全部显示

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bPaginate”: false
3.  \} );

5.\} );  
复制代码  
bProcessing ：开启读取服务器数据时显示正在加载中……特别是大数据量的时候，开启此功能比较好

默认值：

false

类型:

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bProcessing”: true
3.  \} );

5.\} );  
复制代码  
bScrollInfinite ：是否开启不限制长度的滚动条（和sScrollY属性结合使用），不限制长度的滚动条意味着当用户拖动滚动条的时候DataTable会不断加载数据当数据集十分大的时候会有些用处，该选项无法和分页选项同时使用，分页选项会被自动禁止，注意，额外推荐的滚动条会优先与该选项

默认值：

false

类型：

boolean

1.$(document).ready( function() \{

1.  $(‘\#example’).dataTable( \{
2.  “bScrollInfinite”: true,
3.  “bScrollCollapse”: true,
4.  “sScrollY”: “200px”//长200像素
5.  \} );

7.\} );  
复制代码  
bServerSide：开启服务器模式，使用服务器端处理配置datatable。注意：sAjaxSource参数也必须被给予为了给datatable源代码来获取所需的 数据对于每个画。 这个翻译有点别扭。开启此模式后，你对datatables的每个操作 每页显示多少条记录、下一页、上一页、排序（表头）、搜索，这些都会传给服务器相应的值。

默认值：

false

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bServerSide”: true,
3.  “sAjaxSource”: “xhr.php”
4.  \} );

6.\} );  
复制代码  
bInfo ：启用或禁用表信息显示。这显示了关于数据的信息,目前在网页上,包括信息过滤数据,如果行为被执行。这个参数在bServerSide配置后需要用到。

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bInfo”: false//如果这个参数不穿到后台去，服务器分页会报错，据说这个参数包含了表的所有信息
3.  \} );

5.\} );  
复制代码  
bSort ：开启排序功能，每一列都有排序功能，如果关闭了，排序功能将失效，也可以自定义排序功能。单个列的排序可以禁用“bSortable”选项。

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bSort”: false
3.  \} );

5.\} );  
复制代码  
bSortClasses ：是否在当前被排序的列上额外添加sorting\_1,sorting\_2,sorting\_3三个class，当该列被排序的时候，可以切换其背景颜色，该选项作为一个来回切换的属性会增加执行时间（当class被移除和添加的时候），当对大数据集进行排序的时候你或许希望关闭该选项

默认值：

true

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bSortClasses”: false
3.  \} );

5.\} );  
复制代码  
bStateSave ：是否开启状态保存，当选项开启的时候会使用一个cookie保存表格展示的信息的状态，例如分页信息，展示长度，过滤和排序等。这样当终端用户重新加载这个页面的时候可以使用以前的设置

默认值：

false

类型：

boolean

1.$(document).ready( function () \{

1.  $(‘\#example’).dataTable( \{
2.  “bStateSave”: true
3.  \} );

5.\} );  
复制代码  
sScrollX ：是否开启水平滚动，当一个表格过于宽以至于无法放入一个布局的时候，或者表格有太多列的时候，你可以开启该选项从而在一个可横向滚动的视图里面展示表格，该属性可以是css设置，或者一个数字（作为像素量度来使用）

默认值：

blank string - i.e. disabled

类型：

string

1.$(document).ready( function() \{

1.  $(‘\#example’).dataTable( \{
2.  “sScrollX”: “100%”,
3.  “bScrollCollapse”: true
4.  \} );

6.\} );  
复制代码  
sScrollY：是否开启垂直滚动，垂直滚动会驱使DataTable设置为给定的长度，任何溢出到当前视图之外的数据可以通过垂直滚动进行察看当在小范围区域中显示大量数据的时候，可以在分页和垂直滚动中选择一种方式，该属性可以是css设置，或者一个数字（作为像素量度来使用）

默认值：

blank string - i.e. disabled

类型：

string

1.$(document).ready( function() \{

1.  $(‘\#example’).dataTable( \{
2.  “sScrollY”: “200px”,
3.  “bPaginate”: false
4.  \} );

6.\} );