JQuery Datatable 简介

最新推荐文章于 2024-08-01 11:09:48 发布

梁云亮

最新推荐文章于 2024-08-01 11:09:48 发布

阅读量713

点赞数

分类专栏： # TypeScript/JavaScript/JQuery 文章标签： datatable

本文链接：https://blog.csdn.net/lianghecai52171314/article/details/106267576

版权

TypeScript/JavaScript/JQuery 专栏收录该内容

73 篇文章 4 订阅

订阅专栏

中文官网：

http://datatables.club/

使用DataTable基本手册：

http://datatables.club/manual/

在线API：

http://datatables.club/reference/

简介

DataTables是一个jQuery的表格插件。这是一个高度灵活的工具，依据的基础逐步增强，这将增加先进的互动控制，支持任何HTML表格。主要特点：

自动分页处理
即时表格数据过滤
数据排序以及数据类型自动检测
自动处理列宽度
可通过CSS定制样式
支持隐藏列
易用
可扩展性和灵活性
国际化
动态创建表格
免费的

属性表

要注意的是，要被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'	又是水平滚动相关的，没搞懂啥意思

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

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

常用到的配置说明：

$('#example').dataTable({
                "bLengthChange": true, //开关，是否显示每页显示多少条数据的下拉框
                "aLengthMenu": [[5, 10, 25, -1], [5, 10, 25, "所有"]],//设置每页显示数据条数的下拉选项
                'iDisplayLength': 5, //每页初始显示5条记录
                'bFilter': false,  //是否使用内置的过滤功能（是否去掉搜索框）
                "bInfo": true, //开关，是否显示表格的一些信息(当前显示XX-XX条数据，共XX条)
                "bPaginate": true, //开关，是否显示分页器
                "bSort": false, //是否可排序 
                "oLanguage":{  //语言转换
                    "sInfo": "显示第 _START_ 至 _END_ 项结果，共_TOTAL_ 项",
                    "sLengthMenu": "每页显示 _MENU_ 项结果",
                    "oPaginate": {
                        "sFirst": "首页",
                        "sPrevious": "前一页",
                        "sNext": "后一页",
                        "sLast": "尾页"
                        }
                }
            });

汉化

默认情况下生成的表格都是英文表格，因此需要进行本地化，datatable通过引入一个json数组文件实现本地化datatables_language.json

{
    "sProcessing": "处理中...",
    "sLengthMenu": "显示 _MENU_ 项结果",
    "sZeroRecords": "没有匹配结果",
    "sInfo": "显示第 _START_ 至 _END_ 项结果，共 _TOTAL_ 项",
    "sInfoEmpty": "显示第 0 至 0 项结果，共 0 项",
    "sInfoFiltered": "(由 _MAX_ 项结果过滤)",
    "sInfoPostFix": "",
    "sSearch": "搜索:",
    "sUrl": "",
    "sEmptyTable": "表中数据为空",
    "sLoadingRecords": "载入中...",
    "sInfoThousands": ",",
    "oPaginate": {
        "sFirst": "首页",
        "sPrevious": "上页",
        "sNext": "下页",
        "sLast": "末页"
    },
    "oAria": {
        "sSortAscending": ": 以升序排列此列",
        "sSortDescending": ": 以降序排列此列"
    }
}

然后在生成表格的时候引入就行了

$('#datatable_xs').DataTable({
        language: {
            "url": "js/assets/plugins/tables/datatables/datatables_language.json"
        },
        "processing": true,
        "searching": true,
        "serverSide": true
});