dataTable 参数说明

参数名

说明

参考值

默认值

deferLoading

这个参数只有在ServerSide为Ture的时候才有作用,主要是针对列表已经通过HTML显示了一部分数据,而通知远程加载可以忽略这部分数据,在实际使用中这种情况并不常见.

Number   /Array

false

destroy

设为ture时通知dataTable函数完全重新建立一个新的控件实例,在一个页面内反复对同一个控件加载dataTable函数并且想重新建立控件时使用.

Boolean

false

displayStart

列表初始显示的行索引,根据给出的行索引会自动翻页,比如一个每页10个的列表,那么给出20可以让其翻到第二页

Number

无

dom

比较复杂的配置项,简言之就是通过一个自定义的字符串来定义DataTables里面所有组件的显示,位置和显隐.

具体请详见:

http:///reference/option/dom

String

“lfrtip”

lengthMenu

定义页面长度组件里面的选项.

Array

[ 10, 25,   50]

orderCellsTop

当然表头有多层td组成的时候,必须定义哪一个td的数据用于排序,false表示底部td,true表示顶部td. 比如以下情况:

                       

1	2.1
	2.2

 

true的时候排序会用2.1, false的时候排序会用2.2.

Boolean

false

orderClasses

定义是否排序的列进行高亮显示

Boolean

true

order

定义列表的初始排序设定,为一个2维数组,子数组包括2个值,列索引和排序方向(asc/desc): 例如

"order": [[ 0, 'asc' ], [ 1, 'asc' ]]

Array

[[0, 'asc']]

orderMulti

控制是否支持多重排序,如果为true,可以通过shift+点击列头实现多重排序,或者通过API实现,否则禁用该功能.

Boolean

true

orderFixed

自定义固定的排序策略,该策略在任何排序操作中总是起效.可以通过对一个列的固定排序(可以是隐藏的列)来定义列表默认的排序策略.

数组方式,定义优先排序策略,如:

"orderFixed": [ 0, 'asc' ]

该参数说明无论如何排序,永远先进行第一列的正向排序.

对象方式,可以利用关键字pre或post来定义这个规则是优先生效还是置后生效.

"orderFixed": {

          "pre": [ 0, 'asc' ],

          "post": [ 1, 'asc' ]

    }

Array/Object

无

pageLength

定义初始的页长

Number

10

pagingType

定义翻页组件的样式(有4个选择):

simple -  只有上一页和下一页2个按钮

simple_numbers   – 上一页,下一页和页码

full – 首页,末页,上一页,下一页4个按钮

full_numbers   – 全部按钮和页面

String

simple_numbers

scrollCollapse

在设置了一定的scrollY值后起效,为true时,当列表内容不足以撑满scrollY的设定值时,列表高度会自动适应内容.

Boolean

false

search

定义列表的初始搜索/过滤条件

Search对象可以有以下属性:

Object

无

search.search

过滤字符串,注意在默认设置下,所有列的数据都会参与过滤.比如当这个属性为”a”的时候,任何一个列只要包含”a”的行就会被显示.为空表示全部

String

无

search.caseInsensitive

搜索是是否忽略大小写,true为忽略

Boolean

true

search.regex

定义搜索字符串是否为一个正则表达式

Boolean

fasle

search.smart

禁用获取启用DataTables控件内置的只能过滤算法,这个算法会把搜索字符串进行分割并只能搜索,关闭这个算法仅仅实现简单的字符串查找,false为关闭

Boolean

true

searchCols

分别定义每个列的过滤条件.该参数是一个对象数组,每个对象有2个属性:

search: 搜索字符串

escapeRegex:   是否是正则表达式

注意不需要设置过滤的列也需要用null占位,比如:

"searchCols": [

    null,

    {   "search": "My filter" },

    null,

    {   "search": "^[0-9]", "escapeRegex": false }

  ]

Array

无

stripeClasses

定义一个字符串数组,在显示行的时候依次使用里面的字符串作为行的class

Array

'odd’ & 'even’