1.10 版本的参数名称转换

DataTables 1.10 引入了使用驼峰命名法,而不是在 1.9 及更早版本中使用的旧匈牙利命名法。新的 API 也遵循这个新的命名方案。

此更改是完全向后兼容的,你可以继续使用旧的参数名称和 API 方法,就像以前一样。但是,如果你想将参数和 API 方法的用法更新为新方法,请使用以下表格在两种参数名称形式之间进行映射。大多数都是从匈牙利命名法到驼峰命名法的简单转换,但有一些在新的选项和 API 中也已重命名以实现命名一致性。

初始化

现在可以使用以下方法创建 DataTable

  • $(...).dataTable() - 创建一个 DataTable 并返回一个 jQuery 对象(这是 1.9 样式)
  • $(...).DataTable() - 创建一个 DataTable 并返回一个新的 DataTables API 实例

这两种方法在 DataTables 1.10+ 中都可用。

选项

匈牙利命名法 驼峰命名法 含义
aaData data 用作表格显示数据的數據。
aaSorting order 应用于表格的初始排序(排序)
aaSortingFixed orderFixed 始终应用于表格的排序
aDataSort columns.orderData 将多个列排序定义为列的默认排序
aLengthMenu lengthMenu 更改页面长度select 列表中的选项。
aTargets columnDefs.targets 指定列定义应应用于的列。
aoColumns columns 列配置数组。
aoColumnDefs columnDefs 列定义配置数组。
aoSearchCols searchCols 为单个列定义初始搜索。
asSorting columns.orderSequence 排序方向应用顺序
asStripeClasses stripeClasses 为表格中的行设置斑马线类名。
bAutoWidth autoWidth 功能控制 DataTables 的智能列宽处理
bDeferRender deferRender 功能控制延迟渲染,以加快初始化速度。
bDestroy destroy 销毁与选择器匹配的任何现有表格,并使用新选项替换。
bFilter searching 功能控制搜索(过滤)功能
bInfo info 功能控制表格信息显示字段
bJQueryUI jQueryUI 使用标记和类为表格进行 jQuery UI ThemeRoller 主题化。
bLengthChange lengthChange 功能控制最终用户更改表格分页显示长度的能力。
bPaginate paging 启用或禁用表格分页。
bProcessing processing 功能控制处理指示器。
bRetrieve retrieve 检索现有的 DataTables 实例
bScrollAutoCss 已移除
bScrollCollapse scrollCollapse 允许表格在显示有限数量的行时降低高度。
bScrollInfinite 已移除
bSearchable columns.searchable 启用或禁用对该列中的数据的过滤。
bServerSide serverSide 功能控制 DataTables 的服务器端处理模式。
bSort ordering 功能控制 DataTables 中的排序(排序)功能。
bSortable columns.orderable 启用或禁用对该列的排序
bSortCellsTop orderCellsTop 控制排序事件处理程序将在列中的哪个单元格上应用。
bSortClasses orderClasses 突出显示表格主体中正在排序的列
bStateSave stateSave 状态保存 - 在页面重新加载时恢复表格状态
bUseRendered 已移除 使用 columns.render
bVisible columns.visible 启用或禁用该列的显示
fnCookieCallback 已移除
fnCreatedCell columns.createdCell 单元格创建回调,允许 DOM 操作
fnCreatedRow createdRow 每当为表格主体创建 TR 元素时调用的回调。
fnDrawCallback drawCallback DataTables 每执行一次绘制时都会调用的函数。
fnFooterCallback footerCallback 页脚显示回调函数。
fnFormatNumber formatNumber 数字格式化回调函数。
fnHeaderCallback headerCallback 页眉显示回调函数。
fnInfoCallback infoCallback 表格摘要信息显示回调。
fnInitComplete initComplete 初始化完成回调。
fnPreDrawCallback preDrawCallback 预绘制回调。
fnRender 已移除 使用 columns.render
fnRowCallback rowCallback 行绘制回调。
fnServerData ajax 从 Ajax 源加载表格内容的数据
fnServerParams ajax 从 Ajax 源加载表格内容的数据
fnStateLoad stateLoadCallback 定义应从何处以及如何加载保存的状态的回调
fnStateLoaded stateLoaded 状态加载回调。
fnStateLoadParams stateLoadParams 状态加载 - 数据操作回调
fnStateSave stateSaveCallback 定义表格状态如何存储以及存储位置的回调
fnStateSaveParams stateSaveParams 状态保存 - 数据操作回调
iCookieDuration stateDuration 保存状态有效期
iDataSort columns.orderData 将多个列排序定义为列的默认排序
iDeferLoading deferLoading 延迟加载服务器端数据,直到第二次绘制
iDisplayLength pageLength 更改初始页面长度(每页行数)
iDisplayStart displayStart 初始分页起点
iScrollLoadGap 已移除
iTabIndex tabIndex 键盘导航的 Tab 索引控制
mData columns.data 从行数据对象/数组设置列的数据源
mRender columns.render 渲染(处理)数据以在表格中使用
oLanguage.oAria.sSortAscending language.aria.sortAscending 用于 WAI-ARIA 特定属性的语言字符串
oLanguage.oAria.sSortDescending language.aria.sortDescending 用于 WAI-ARIA 特定属性的语言字符串
oLanguage.oPaginate.sFirst language.paginate.first 分页“第一页”按钮字符串
oLanguage.oPaginate.sLast language.paginate.last 分页“最后一页”按钮字符串
oLanguage.oPaginate.sNext language.paginate.next 分页“下一页”按钮字符串
oLanguage.oPaginate.sPrevious language.paginate.previous 分页“上一页”按钮字符串
oLanguage.sEmptyTable language.emptyTable 表格没有记录的字符串
oLanguage.sInfo language.info 表格摘要信息显示字符串
oLanguage.sInfoEmpty language.infoEmpty 当表格为空或没有记录时使用的表格摘要信息字符串
oLanguage.sInfoFiltered language.infoFiltered 当表格被过滤时,附加到摘要信息的字符串
oLanguage.sInfoPostFix language.infoPostFix 附加到所有其他摘要信息字符串的字符串
oLanguage.sInfoThousands language.thousands 千位分隔符
oLanguage.sLengthMenu language.lengthMenu 页面长度选项字符串
oLanguage.sLoadingRecords language.loadingRecords 加载信息显示字符串 - 在 Ajax 加载数据时显示
oLanguage.sProcessing language.processing 处理指示器字符串
oLanguage.sSearch language.search 搜索输入字符串
oLanguage.sUrl language.url 从远程文件加载语言信息
oLanguage.sZeroRecords language.zeroRecords 表格由于过滤而为空的字符串
oSearch search 在 DataTables 中设置初始过滤器和/或过滤选项。
sAjaxDataProp ajax.dataSrc 表格数据的數據属性或操作方法
sAjaxSource ajax 从 Ajax 源加载表格内容的数据
sCellType columns.cellType 要为列创建的单元格类型
sClass columns.className 要分配给列中每个单元格的类
sContentPadding contentPadding 在计算表格的最佳宽度时,向文本内容添加填充。
sCookiePrefix 已移除
sDefaultContent columns.defaultContent 为列设置默认的静态内容
sDom dom 定义页面上要出现的表格控制元素及其顺序
sName columns.name 为列设置描述性名称
sPaginationType pagingType 分页按钮显示选项
sScrollX scrollX 水平滚动
sScrollXInner scrollXInner 在 1.10 中没有记录
sScrollY scrollY 垂直滚动
sServerMethod ajax 从 Ajax 源加载表格内容的数据
sSortDataType columns.orderDataType 实时 DOM 排序类型分配
sTitle columns.title 设置列标题
sType columns.type 设置列类型 - 用于过滤和排序字符串处理
sWidth columns.width 列宽度分配

API

请注意,这是将旧 API 的用法转换为新的 API 的参考。新的 API 更加全面,具有许多此处未显示的附加选项。请查看 API 参考,以获取有关如何使用它的完整信息。

匈牙利命名法 驼峰命名法 含义
$ $ 对整个表格执行 jQuery 选择操作。
_ row().data()rows().data()cell().data() 从行、列或单元格中获取数据
fnAddData row.add()rows.add() 向表格添加一个或多个新行。
fnAdjustColumnSizing columns.adjust() 重新计算列宽度
fnClearTable clear() 清除表格中的所有数据。
fnClose row().child.hide() 隐藏父行的子行
fnDeleteRow row().remove()rows().remove() 从 DataTable 中删除一个或多个行。
fnDestroy destroy() 销毁当前上下文中的 DataTables。
fnDraw draw() 重新绘制表格。
fnFilter search()column().search()columns().search() 在表格中搜索数据。
fnGetData row().data()rows().data()cell().data() 获取行、列或单元格的数据
fnGetNodes row().node()rows().nodes()cell().node() 获取行、列或单元格的节点
fnGetPosition row().index()cell().index() 获取所选行、列或单元格的索引信息
fnIsDataTable $.fn.dataTable.isDataTable() 检查表格节点是否为数据表
fnIsOpen row().child.isShown() 检查父行的子行是否可见
fnOpen row().child() 使父行的子行可见
fnPageChange page() 获取/设置表格的当前页
fnSetColumnVis column().visible() 获取/设置单个选定列的可见性
fnSettings settings() 获取表格的设置对象
fnSort order()column().order() 按选定列对表格进行排序
fnSortListener order.listener() 为给定列的元素添加排序监听器
fnTables $.fn.dataTable.tables() 获取页面上的所有数据表
fnUpdate row().data()cell().data() 设置行或单元格的数据
fnVersionCheck $.fn.dataTable.versionCheck() 版本号兼容性检查函数