描述(Description)
这个方提供获取DataTables的排序和控制。
以二维数组的格式储存排序信息,数据格式如下:
1
2
3
4
5
6
[
[ colIdx_1, orderingDirection_1 ],
[ colIdx_2, orderingDirection_2 ],
...,
[ colIdx_n, orderingDirection_n ]
]
其中colIdx_x
是排序列的索引值,orderingDirection_n
是排序的方向(
descString
(descending降序)或者
ascString
(ascending升序))- 注意这些必须是小写。索引值从0开始,比如表中第一列索引值为0,第二列索引值为1。
使用这种格式,DataTables可以实现单列排序或多列排序。为了方便,该方法允许传入多个一维数组或一个二维数组来多列排序。但是获取排序信息,DataTables总是返回二维数组。
请注意,此方法只设置表的排序,实际上不执行排序,要达到最终的效果,还需要执行
draw()API
方法,像这样
table.order([0,'desc']).draw();
类型(Type)
这个选项能够接受以下类型的参数:
function order()
描述(Description):
获取表格的排序信息。如果当前有多个DataTables实例对象,将返回找到的第一个实例对象的排序信息。使用
table()API
来获取不同表格实例。
返回(Returns):
包含当前表格排序信息的二维数组。该二维数组与用来设置排序的数据格式相同(见下文)。
function order( order [, …] )
描述(Description):
使用一维数组设置表格的排序。请注意,这并不执行排序,需要使用
draw()API
方法来执行。
参数(Parameters):
名称(Name) | 类型(Type) | 是否可选(Optional) | |
---|---|---|---|
1 | order |
arrayType
|
No |
[ columnIndex, "asc|desc" ] 格式的数组,比如 [ 1, "desc" ] 代表第二列降序排列。
|
|||
2 | ... |
arrayType
|
Yes - default: |
附加数组的格式与第一个参数相同,允许多列排序。比如[ 1, "desc" ],[ 2, "asc" ] 代表第二列降序,第三列升序排列。
|
返回(Returns):
DataTables API 实例对象
function order( order )
描述(Description):
使用二维数组设置表格的排序。请注意,这并不执行排序,需要使用
draw()API
方法来执行。
参数(Parameters):
名称(Name) | 类型(Type) | 是否可选(Optional) | |
---|---|---|---|
1 | order |
arrayType
|
No |
[[ columnIndex, "asc|desc" ],...,[ columnIndex, "asc|desc" ]] 格式的二维数组,比如 [[ 0, "desc" ],[ 1, "asc" ]] 代表第一列降序,第二列升序排列。
|
返回(Returns):
DataTables API 实例对象
例子(Example)
获取表格的排序信息:
1
2
3
4
var table = $('#example').DataTable();
var order = table.order();
alert( '第 '+order[0][0]+' 列是排序列' );
使用一维数组设置表格排序,第二列升序排列并且重绘:
1
2
3
var table = $('#example').DataTable();
table.order( [ 1, 'asc' ] ).draw();
使用多个一维数组设置表格排序,第二,三列升序排列并且重绘:
1
2
3
var table = $('#example').DataTable();
table.order( [ 1, 'asc' ], [ 2, 'asc' ] ).draw();
和上述例子效果一样,不同的是使用二维数组来设置表格排序:
1
2
3
var table = $('#example').DataTable();
table.order( [[ 1, 'asc' ], [ 2, 'asc' ]] ).draw();
相关属性(Related)
下面的选项是直接相关的,也可能是您的应用程序的开发非常有用。
Options