Datatables 1.10.x在命名上与1.9.x的有区别,新版的使用的是驼峰的命名规则,而之前的是采用
当然,这些变化都是向下兼容的,你可以继续使用旧版本的api方法的参数和名称。 如果你要是用新版本的api方法,请参考下面表格的对照表,大多数的都是直接从匈牙利命名到驼峰命名,极个别重命名,还添加了新的属性名称。
初始化
现在可以这样创建一个Datatables:
$(...).dataTable()创建一个Datatables并返回一个jquery对象(1.9-)
$(...).DataTable()创建一个Datatables并返回一个新的Datatables
两种方法都可以在1.10+版本中使用
选项(Options)
匈牙利式 | 驼峰式 | 含义 |
---|---|---|
aaData | 给表格显示数据 | |
aaSorting | 表格初始化排序 | |
aaSortingFixed | Ordering to always be applied to the table | |
aDataSort | 定义多个列作为列的默认顺序 | |
aLengthMenu | 改变每页显示条数列表的选项 | |
aTargets | 适用于指定一个特定的列 | |
aoColumns | 列配置数组 | |
aoColumnDefs | 列定义配置数组 | |
aoSearchCols | 给个别列定义搜索选项 | |
asSorting | 指定排序 | |
asStripeClasses | 在表中设置斑马条纹类的行 | |
bAutoWidth | 让Datatables自动计算宽度 | |
bDeferRender | 延迟渲染可以提高Datatables的加载速度 | |
bDestroy | 允许重新实例化Datatables | |
bFilter | 开启搜索功能 | |
bInfo | 开启Datatables信息显示 | |
bJQueryUI | 使用jqueryui样式(需要引入jqueryui的css) | |
bLengthChange | 允许改变每页显示的数据条数 | |
bPaginate | 允许表格分页 | |
bProcessing | 显示加载信息 | |
bRetrieve | 检索一个已存在的Datatables实例 | |
bScrollAutoCss | 废弃 | |
bScrollCollapse | 开启滚动条 | |
bScrollInfinite | 废弃 | |
bSearchable | 定义列是否允许搜索 | |
bServerSide | 开启服务器模式 | |
bSort | 是否启用Datatables排序 | |
bSortable | 开启或关闭某列的排序 | |
bSortCellsTop | Control which cell the order event handler will be applied to in a column | |
bSortClasses | 排序列高亮显示 | |
bStateSave | 允许浏览器缓存Datatables,以便下次恢复之前的状态 | |
bUseRendered | 废弃 | Use |
bVisible | 列是否显示 | |
fnCookieCallback | 废弃 | |
fnCreatedCell | 单元格被创建回调函数,允许dom操作 | |
fnCreatedRow | tr被创建回调函数 | |
fnDrawCallback | 表格重绘的时候回调函数 | |
fnFooterCallback | foot显示回调函数 | |
fnFormatNumber | 数字格式化回调函数 | |
fnHeaderCallback | thead显示回调函数 | |
fnInfoCallback | 表格主要信息显示回调函数 | |
fnInitComplete | 表格加载完成回调函数 | |
fnPreDrawCallback | 预绘制回调函数 | |
fnRender | 废弃 | Use |
fnRowCallback | 行重绘回调 | |
fnServerData | 从 Ajax 源加载数据的表的内容 | |
fnServerParams | 从 Ajax 源加载数据的表的内容 | |
fnStateLoad | 定义在何处以及如何应加载已保存的状态的回调 | |
fnStateLoaded | 状态被读取回调 | |
fnStateLoadParams | 加载状态,数据操作回调 | |
fnStateSave | 定义如何存和在哪里储表状态回调 | |
fnStateSaveParams | 状态保存,数据操作回调 | |
iCookieDuration | 状态保存的有效期 | |
iDataSort | 定义多个列作为列的默认顺序 | |
iDeferLoading | 延迟加载服务器端数据直到第二次重绘 | |
iDisplayLength | 更改初始页面长度 (每页的行数) | |
iDisplayStart | 初始分页起始点 | |
iScrollLoadGap | 废弃 | |
iTabIndex | 选项卡索引控件的键盘导航 | |
mData | 从行数据对象/数组设置列的数据源 | |
mRender | Render (process) the data for use in the table | |
oLanguage.oAria.sSortAscending | 用于WAI-ARIA(无障碍网页应用)属性 | |
oLanguage.oAria.sSortDescending | 用于WAI-ARIA(无障碍网页应用)属性 | |
oLanguage.oPaginate.sFirst | 翻页中“首页”字符串 | |
oLanguage.oPaginate.sLast | 翻页中“尾页”字符串 | |
oLanguage.oPaginate.sNext | 翻页中“下一页”字符串 | |
oLanguage.oPaginate.sPrevious | 翻页中“上一页”字符串 | |
oLanguage.sEmptyTable | 表格中没有数据时显示的字符串 | |
oLanguage.sInfo | 表格主要信息显示字符串 | |
oLanguage.sInfoEmpty | 当表格没有数据和搜索记录时,表格主要信息显示字符串 | |
oLanguage.sInfoFiltered | 当使用搜索功能后,表格主要信息出追加的字符 | |
oLanguage.sInfoPostFix | 追加到所有其他主要信息字符串之后 | |
oLanguage.sInfoThousands | 千分位分隔符 | |
oLanguage.sLengthMenu | 页面显示数据条数选项 | |
oLanguage.sLoadingRecords | 当ajax加载数据时-加载信息显示字符串 | |
oLanguage.sProcessing | 显示正在处理字符串 | |
oLanguage.sSearch | 搜索框显示字符串 | |
oLanguage.sUrl | 从远程加载语言信息文件url | |
oLanguage.sZeroRecords | 过滤后空的结果字符串 | |
oSearch | 设置一个在Datatables初始化时的搜索选项 | |
sAjaxDataProp | 表数据的数据属性或操作方法 | |
sAjaxSource | 从 Ajax 源加载数据的表的内容 | |
sCellType | 要为列创建的单元格类型 | |
sClass | 指定单元格样式 | |
sContentPadding | 给文本内容添加填充被用来计算最合适的表格 | |
sCookiePrefix | 废弃 | |
sDefaultContent | 给列设置默认的,静态的内容 | |
sDom | 按什么顺序定义表的控制元素在页面上出现 | |
sName | 设置列的描述性名称 | |
sPaginationType | 分页按钮种类显示选项 | |
sScrollX | 水平滚动条 | |
sScrollXInner | scrollXInner | 没有文档在1.10中 |
sScrollY | 垂直滚动条 | |
sServerMethod | 从 Ajax 源加载数据的表的内容的方式 | |
sSortDataType | Live DOM sorting type assignment | |
sTitle | 给列设置名称 | |
sType | 设置用于筛选和排序字符串处理的列类型 | |
sWidth | 设置列宽 |
API
以下是旧的api转换新的,新的api有很多,下面没有全部列出来。关于如何使用它,请参考api完整信息。
匈牙利式 | 驼峰式 | 含义 |
---|---|---|
$ | Perform a jQuery selection action on the full table. | |
_ | , , | 从行、列和单元格中获取数据 |
fnAddData | , | 给表格添加一行或多行 |
fnAdjustColumnSizing | 重新计算列的宽度 | |
fnClearTable | 清除表格的所有数据 | |
fnClose | 隐藏父行的子行 | |
fnDeleteRow | , | 从Datatables删掉一行或或者更多 |
fnDestroy | 从当前上下文销毁掉Datatables对象 | |
fnDraw | 重绘表格 | |
fnFilter | , , | 从表格里搜索数据 |
fnGetData | , , | 从列,行,单元格中获取数据 |
fnGetNodes | , , | 从列,行和单元格里获取节点 |
fnGetPosition | , | 获取有关选定的行、 列或单元格的索引信息 |
fnIsDataTable | 检查表格的节点是不是Datatable对象 | |
fnIsOpen | 检查子行的父行是否可见 | |
fnOpen | 使父行的子行可见 | |
fnPageChange | 获取/设置表的当前页 | |
fnSetColumnVis | 获取/设置单个所选列的可见性 | |
fnSettings | 获取表的设置对象 | |
fnSort | , | 选择指定列排序 |
fnSortListener | 给指定的列添加排序的监听 | |
fnTables | 在本页得到所有的Datatables | |
fnUpdate | , | 设置行或单元格的数据 |
fnVersionCheck | 版本号码的兼容性检查功能 |
Translation from DataTables.net, with permission