API

DataTables 有一个广泛的 API,可用于访问表中包含的数据,并在表初始化完成后以其他方式操作表。DataTables API 的设计旨在体现表中数据的结构,以及你通常如何通过 API 与表进行交互。它还可以通过提供附加特性和操作的 扩展插件 来完成。

可以通过以下方法访问 API

  • new DataTable.Api( 选择器 );
  • $( 选择器 ).DataTable();
  • $( 选择器 ).dataTable().api();

每个方法的结果是 DataTables API 对象的一个实例,其中在其上下文中包含选择器发现的表。如果正在使用 jQuery,请务必注意 $( 选择器 ).DataTable()$( 选择器 ).dataTable() 之间的区别。前者返回一个 DataTables API 实例,而后者返回一个 jQuery 对象。

有关 DataTables API 操作方式的一般信息,包括其连接、如何使用多张表和此参考中使用的术语的定义,请参阅 API 手册

组件库 名称 摘要
DataTables - 核心

$()

对整个表执行 jQuery 选择操作。

DataTables - 核心

ajax

用于 Ajax 方法的命名空间

DataTables - 核心

ajax.json()

获取 DataTables 制作的最新 Ajax 请求中获取的 JSON 数据

DataTables - 核心

ajax.params()

获取在最近的 Ajax 请求中 DataTables 提交到服务器的数据

DataTables - 核心

ajax.reload()

从 Ajax 数据源重新加载表数据

DataTables - 核心

ajax.url()

获取/设置 DataTables 用于 Ajax 获取数据的 URL

DataTables - 核心

ajax.url().load()

从新设置的数据源 URL 加载数据

DataTables - 核心

clear()

清除表中的所有数据。

DataTables - 核心

column().init()

获取一列的初始化选项。

DataTables - 核心

column().search.fixed()

获取/设置应用于一列的命名搜索。

DataTables - 核心

columns().init()

获取所选列的初始化选项。

DataTables - 核心

columns().search.fixed()

获取/设置应用于一列的命名搜索。

DataTables - 核心

data()

获取整个表的数据。

DataTables - 核心

destroy()

销毁当前上下文中的 DataTables。

DataTables - 核心

draw()

重新绘制表。

DataTables - 核心

i18n()

国际化标记查找。

DataTables - 核心

init()

获取用于表的初始化选项。

DataTables - 核心

off()

删除表事件。

DataTables - 核心

on()

表事件监听器。

DataTables - 核心

one()

监听表事件一次,然后删除监听器。

DataTables - 核心

order()

获取/设置应用于表的排序。

DataTables - 核心

order.fixed()

获取/设置应用于表的固定排序。

DataTables - 核心

order.listener()

对元素添加排序监听器,针对给定的列。

DataTables - 核心

page()

获取/设置表的当前页面。

DataTables - 核心

page.info()

获取有关表的分页信息

DataTables - 核心

page.len()

获取/设置表的页面长度。

DataTables - 核心

processing()

设置 DataTable 的处理指示器状态。

DataTables - 核心

search()

在表中搜索数据。

DataTables - 核心

search.fixed()

获取/设置应用于表的命名搜索。

DataTables - 核心

settings()

获取表的设置对象

DataTables - 核心

state()

获取/设置表的 state

DataTables - 核心

state.clear()

清除表的已保存 state。

DataTables - 核心

state.loaded()

获取在初始化中加载的表格状态。

DataTables - 核心

state.save()

触发 state 保存。

DataTables - 核心

trigger()

触发事件。

DataTables - 单元格

cell()

从表格中选择单个单元格。

DataTables - 单元格

cell().cache()

获取所选单元格的 DataTables 缓存数据

DataTables - 单元格

cell().data()

获取 / 设置所选单元格的数据

DataTables - 单元格

cell().index()

获取所选单元格的索引信息

DataTables - 单元格

cell().invalidate()

使 DataTables 中保存的所选单元格的数据无效

DataTables - 单元格

cell().node()

获取所选单元格的 DOM 元素

DataTables - 单元格

cell().render()

获取单元格的呈现数据

DataTables - 单元格

cells()

从表格中选择多个单元格。

DataTables - 单元格

cells().cache()

获取所选单元格的 DataTables 缓存数据

DataTables - 单元格

cells().data()

获取所选单元格的数据

DataTables - 单元格

cells().every()

遍历每个所选单元格,在这种情况下,将函数上下文设定为单元格。

DataTables - 单元格

cells().indexes()

获取所选单元格的索引信息

DataTables - 单元格

cells().invalidate()

使 DataTables 中保存的所选单元格的数据无效

DataTables - 单元格

cells().nodes()

获取所选单元格的 DOM 元素

DataTables - 单元格

cells().render()

获取单元格集合的呈现数据

DataTables - 列

column()

从表格中选择单个列。

DataTables - 列

column().cache()

获取所选列的 DataTables 缓存数据。

DataTables - 列

column().data()

获取所选列中单元格的数据。

DataTables - 列

column().dataSrc()

获取所选列的数据源属性。

DataTables - 列

column().footer()

获取所选列的页脚节点。

DataTables - 列

column().header()

获取所选列的页眉节点。

DataTables - 列

column().index()

获取所选列的列索引。

DataTables - 列

column().nodes()

获取所选列的单元格节点。

DataTables - 列

column().order()

根据所选列对表格进行排序。

DataTables - 列

column().orderable()

获取列的可排序状态信息。

DataTables - 列

column().render()

获取列的呈现数据

DataTables - 列

column().search()

在所选列中搜索数据。

DataTables - 列

column().title()

获取 / 设置列的标题。

DataTables - 列

column().type()

获取列的数据类型。

DataTables - 列

column().visible()

获取 / 设置单个所选列的可视性。

DataTables - 列

column().width()

获取列的宽度。

DataTables - 列

column.index()

在列索引格式之间进行转换

DataTables - 列

columns()

从表格中选择多列。

DataTables - 列

columns().cache()

获取所选列的 DataTables 缓存数据。

DataTables - 列

columns().data()

获取所选列中单元格的数据。

DataTables - 列

columns().dataSrc()

获取所选列的数据源属性。

DataTables - 列

columns().every()

遍历每个所选列,在这种情况下,将函数上下文设定为列。

DataTables - 列

columns().footer()

获取所选列的页脚节点。

DataTables - 列

columns().header()

获取所选列的页眉节点。

DataTables - 列

columns().indexes()

获取所选列的列索引。

DataTables - 列

columns().nodes()

获取所选列的单元格节点。

DataTables - 列

columns().order()

根据所选列对表格进行排序。

DataTables - 列

columns().orderable()

获取所选列的可排序状态信息。

DataTables - 列

columns().render()

获取列集合的呈现数据

DataTables - 列

columns().search()

在所选列中搜索数据。

DataTables - 列

columns().titles()

获取 / 设置多列的标题。

DataTables - 列

columns().types()

获取所选列的数据类型。

DataTables - 列

columns().visible()

获取/设置所选列的可见性。

DataTables - 列

columns().widths()

获取一组列的宽度.

DataTables - 列

columns.adjust()

重新计算列的宽度

DataTables - 行

row()

从表中选择单行。

DataTables - 行

row().cache()

获取 DataTables 缓存的所选行的数据。

DataTables - 行

row().child

行子方法名称空间

DataTables - 行

row().child()

获取/设置所选主表行的子行

DataTables - 行

row().child().hide()

在创建新子行后隐藏子行

DataTables - 行

row().child().remove()

销毁所选父行的子行

DataTables - 行

row().child().show()

使新定义的子行可见

DataTables - 行

row().child.hide()

隐藏父行的子行

DataTables - 行

row().child.isShown()

检查父行的子行是否可见

DataTables - 行

row().child.remove()

销毁所选父行的子行

DataTables - 行

row().child.show()

使父行的子行可见

DataTables - 行

row().data()

获取/设置所选行的的数据。

DataTables - 行

row().id()

获取所选行的 ID。

DataTables - 行

row().index()

获取所选行的行索引。

DataTables - 行

row().invalidate()

使 DataTables 中所选行的所保存的数据失效

DataTables - 行

row().node()

获取所选行的行 TR 节点。

DataTables - 行

row().remove()

从 DataTable 中删除所选的行。

DataTables - 行

row.add()

向表中添加新行。

DataTables - 行

rows()

从表中选择多行。

DataTables - 行

rows().cache()

获取 DataTables 缓存的所选行的数据。

DataTables - 行

rows().data()

获取所选行的所有数据。

DataTables - 行

rows().every()

迭代遍历每个所选行,其中函数的环境设定为所讨论的行。

DataTables - 行

rows().ids()

获取所选行的 ID。

DataTables - 行

rows().indexes()

获取所选行的行索引。

DataTables - 行

rows().invalidate()

使 DataTables 中所选行的所保存的数据失效

DataTables - 行

rows().nodes()

获取所选行的行 TR 节点。

DataTables - 行

rows().remove()

从 DataTable 中删除所选的行。

DataTables - 行

rows.add()

向表中添加多行。

DataTables - 表

caption()

获取/设置表的标题

DataTables - 表

caption.node()

获取表的 caption 元素

DataTables - 表

table()

基于 API 环境中的选择器选择表

DataTables - 表

table().body()

获取 API 环境中的表的 tbody 节点

DataTables - 表

table().container()

获取 API 环境中表的 div 容器节点

DataTables - 表

table().footer()

获取 API 环境中表的 tfoot 节点

DataTables - 表

table().footer.structure()

获取表尾结构的 JavaScript 表示形式

DataTables - 表

table().header()

获取 API 环境中表的 thead 节点

DataTables - 表

table().header.structure()

获取表头的 JavaScript 表示形式

DataTables - 表

table().node()

获取 API 环境中表的 table 节点

DataTables - 表

tables()

基于 API 环境中的选择器选择表

DataTables - 表

tables().body()

获取 API 环境中表的 tbody 节点

DataTables - 表

tables().containers()

获取 API 环境中表的 div 容器节点

DataTables - 表

tables().footer()

获取上下文 API 中表格的 tfoot 节点

DataTables - 表

tables().header()

获取上下文 API 中表格的 thead 节点

DataTables - 表

tables().nodes()

获取上下文 API 中表格的 table 节点

DataTables - 实用

any()

确定结果集中是否有任何条目

DataTables - 实用

count()

获取包含在 API 实例中的元素数量

DataTables - 实用

each()

遍历 API 结果集的内容。

DataTables - 实用

eq()

将 Api 实例缩减为单个上下文和结果集。

DataTables - 实用

error()

触发错误消息。

DataTables - 实用

filter()

创建新的 API 实例,其中所有元素均通过给定测试的结果集。

DataTables - 实用

flatten()

将结构化为 2D 数组的 API 实例扁平化为 1D 数组结构。

DataTables - 实用

get()

获取 DataTable 实例的基础数据

DataTables - 实用

includes()

确定 API 结果集是否包含给定的值。

DataTables - 实用

indexOf()

找到 API 实例结果集中某个值的第一个实例。

DataTables - 实用

iterator()

遍历表格、行、列或单元格索引的结果集

DataTables - 实用

join()

将结果集中各元素连接为字符串。

DataTables - 实用

lastIndexOf()

找到 API 实例结果集中某个值的最后一个实例。

DataTables - 实用

length

API 实例结果集中元素的数量。

DataTables - 实用

map()

创建新的 API 实例,其结果集通过回调函数返回的值定义。

DataTables - 实用

pluck()

使用当前结果集中对象的属性值创建新的 API 实例。

DataTables - 实用

pop()

从 API 实例的结果集中删除最后一项。

DataTables - 实用

push()

将一项或多项添加到 API 实例的结果集末尾。

DataTables - 实用

ready()

确定 DataTable 是否就绪。

DataTables - 实用

reduce()

对累加器和 Api 结果集中的每个元素(从左到右)应用回调函数。

DataTables - 实用

reduceRight()

对累加器和 Api 结果集中的每个元素(从右到左)应用回调函数。

DataTables - 实用

reverse()

反转 API 实例的结果集。

DataTables - 实用

shift()

从 API 实例的结果集中删除第一项。

DataTables - 实用

slice()

创建 API 实例的独立副本。

DataTables - 实用

sort()

对 API 实例结果集的元素进行排序。

DataTables - 实用

splice()

修改 Api 实例的结果集的内容,根据需要添加或删除其中的项目。

DataTables - 实用

to$()

将 API 实例转换为 jQuery 对象,其中实例结果集中的对象位于 jQuery 结果集中。

DataTables - 实用

toArray()

从 API 实例中创建本机 Javascript 数组对象。

DataTables - 实用

toJQuery()

将 API 实例转换为 jQuery 对象,其中实例结果集中的对象位于 jQuery 结果集中。

DataTables - 实用

unique()

创建新的 API 实例,其中仅包含实例结果集中的元素中的唯一项。

DataTables - 实用

unshift()

将一项或多项添加到 API 实例的结果集的开头。

DataTables - 静态

DataTable.datetime()

向 DataTables 注册日期/时间格式以供使用

DataTables - 静态

DataTable.feature.register()

创建新的功能,以便用于布局

DataTables - 静态

DataTable.isDataTable()

检查表格节点是否为 DataTable 表格

DataTables - 静态

DataTable.tables()

获取页面中的所有 DataTable 表格

DataTables - 静态

DataTable.type()

获取/设置数据类型详细信息

DataTables - 静态

DataTable.types()

获取已注册的数据类型列表

DataTables - 静态

DataTable.use()

获取/设置 DataTables 使用的库或全局对象

DataTables - 静态

DataTable.util.debounce()

在一个函数被调用前等待一段时间

DataTables - 静态

DataTable.util.diacritics()

在字符串中规范化变音符号字符。

DataTables - 静态

DataTable.util.escapeHtml()

对 HTML 实体进行转义以保证用户输入的字符串安全

DataTables - 静态

DataTable.util.escapeRegex()

对正则表达式字符串中的特殊字符进行转义

DataTables - 静态

DataTable.util.get()

从描述符创建一个读取函数

DataTables - 静态

DataTable.util.set()

从描述符创建一个写入函数

DataTables - 静态

DataTable.util.stripHtml()

从字符串中移除 HTML

DataTables - 静态

DataTable.util.throttle()

限制对一个方法的调用以减少调用频率

DataTables - 静态

DataTable.util.unique()

从数组中获取所有唯一项

DataTables - 静态

DataTable.versionCheck()

版本号兼容性检查函数

AutoFill

autoFill().disable()

禁用 AutoFill 的交互

AutoFill

autoFill().enable()

启用或禁用 AutoFill 的交互

AutoFill

autoFill().enabled()

判断 AutoFill 是否已启用或禁用

按钮

DataTable.fileSave()

将已在客户端创建的文件保存

按钮

button()

选择单个按钮

按钮

button().action()

获取/设置所选按钮的操作函数

按钮

button().active()

获取/设置所选按钮的激活状态

按钮

button().add()

创建一个新按钮并将其添加到文档中

按钮

button().collectionRebuild()

重建按钮集合

按钮

button().disable()

禁用所选按钮

按钮

button().enable()

启用/禁用所选按钮

按钮

button().index()

获取节点的索引

按钮

button().node()

获取所选按钮的按钮节点

按钮

button().popover()

为按钮显示气泡框,允许用户输入额外内容

按钮

button().processing()

获取/设置按钮的处理状态

按钮

button().remove()

移除并删除所选按钮

按钮

button().text()

获取/设置所选按钮的文本

按钮

button().trigger()

触发所选按钮的操作

按钮

buttons()

选择一个或多个按钮

按钮

buttons().action()

获取/设置所选按钮的操作函数

按钮

buttons().active()

设置所选按钮的激活状态

按钮

buttons().collectionRebuild()

重建按钮集合

按钮

buttons().container()

获取单个 Buttons 实例的容器元素

按钮

buttons().containers()

获取一个或多个按钮实例的容器元素

按钮

buttons().destroy()

销毁一个或多个按钮实例并从文档中移除

按钮

buttons().disable()

禁用所选按钮

按钮

buttons().enable()

启用/禁用所选按钮

按钮

buttons().nodes()

获取所选按钮的按钮节点

按钮

buttons().processing()

设置多个按钮的处理状态

按钮

buttons().remove()

移除并删除所选按钮

按钮

buttons().text()

获取/设置所选按钮的文本

按钮

buttons().trigger()

触发所选按钮的操作

按钮

buttons.exportData()

从 DataTable 中获取适合导出的数据

按钮

buttons.exportInfo()

获取许多不同按钮类型共有的导出元信息

按钮

buttons.info()

在模态框中显示和隐藏最终用户的信息

ColReorder

colReorder.disable()

禁用 ColReorder 的交互

ColReorder

colReorder.enable()

启用或禁用 ColReorder 的交互

ColReorder

colReorder.move()

以编程方式移动列

ColReorder

colReorder.order()

获取/设置列顺序

ColReorder

colReorder.reset()

还原已加载的列顺序

ColReorder

colReorder.transpose()

将一列或多列索引转换为当前索引和原始索引,反之亦可

编辑器

cell().edit()

使用内联编辑或气泡编辑编辑单元格

编辑器

cells().edit()

使用气泡编辑编辑单元格

编辑器

editor()

获取与此表格关联的编辑器实例。

编辑器

file()

获取有关已上传文件的详细信息

编辑器

files()

获取多个已上传文件的详细信息

编辑器

row().delete()

删除现有行

编辑器

row().edit()

编辑现有行

编辑器

row.create()

新建行

编辑器

rows().delete()

删除多个现有行

编辑器

rows().edit()

编辑多个现有行

FixedColumns

fixedColumns()

FixedColumns 方法命名空间

FixedColumns

fixedColumns().end()

获取/设置固定在表格末尾的列数

FixedColumns

fixedColumns().left()

获取/设置表格左侧的固定列数

FixedColumns

fixedColumns().right()

获取/设置表格右侧的固定列数

FixedColumns

fixedColumns().start()

获取/设置固定在表格开头的列数

FixedHeader

fixedHeader.adjust()

重新计算表格位置并重新绘制固定元素

FixedHeader

fixedHeader.disable()

禁用固定元素

FixedHeader

fixedHeader.enable()

启用/禁用固定元素

FixedHeader

fixedHeader.enabled()

获取当前已启用状态

FixedHeader

fixedHeader.footerOffset()

获取/设置固定页脚的偏移量

FixedHeader

fixedHeader.headerOffset()

获取/设置固定页眉的偏移量

KeyTable

cell().focus()

聚焦在单元格上

KeyTable

cell.blur()

从表格中取消焦点

KeyTable

keys.disable()

禁用 KeyTable 的交互(鼠标和键盘)

KeyTable

keys.enable()

启用或禁用 KeyTable 的交互(鼠标和键盘)

KeyTable

keys.enabled()

确定表格的 KeyTable 启用状态

KeyTable

keys.move()

将焦点移至相邻的单元格

响应

column().responsiveHidden()

获取表格中列的响应可见性状态

响应

columns().responsiveHidden()

获取表格中列的响应可见性状态

响应

responsive.hasHidden()

确定 Responsive 是否隐藏了表格中的任何列

响应

responsive.index()

li 详细信息元素获取单元格索引

响应

responsive.rebuild()

根据列头单元格的类信息重新计算列断点

响应

responsive.recalc()

在显示发生变化后重新计算 Responsive 使用的宽度

RowGroup

rowGroup().dataSrc()

获取/设置行分组的数据源

RowGroup

rowGroup().disable()

禁用 RowGroup 与表格的交互

RowGroup

rowGroup().enable()

启用或禁用 RowGroup 与表格的交互

RowGroup

rowGroup().enabled()

确定是否在表格上启用了 RowGroup

RowReorder

rowReorder.disable()

禁用用户重新排序行的能力。

RowReorder

rowReorder.enable()

启用/禁用用户重新排序行的能力。

Scroller

row().scrollTo()

滚动到特定行

Scroller

scroller.measure()

重新计算 Scroller 使用的缓存测量值

Scroller

scroller.page()

获取有关当前显示的行的信息

Scroller

scroller.toPosition()

滚动到特定行显示索引

SearchBuilder

searchBuilder.container()

返回 SearchBuilder 容器的节点。

SearchBuilder

searchBuilder.getDetails()

获取当前搜索设置的详细信息

SearchBuilder

searchBuilder.rebuild()

重建为既定状态的搜索

SearchPanes

searchPanes.clearSelections()

清除所有窗格中的选定

SearchPanes

searchPanes.container()

返回窗格容器的节点。

SearchPanes

searchPanes.rebuildPane()

重建窗格,从表重新收集选项。

SearchPanes

searchPanes.resizePanes()

调整所有窗格的大小以适当地填充 SearchPanes 容器。

选择

cell().deselect()

取消选择单个单元格

选择

cell().select()

选择单个单元格

选择

cell().selected()

确定是否已选择单元格

选择

cells().deselect()

取消选择单元格

选择

cells().select()

选择单元格

选择

column().deselect()

取消选择单个列

选择

column().select()

选择单个列

选择

column().selected()

确定是否已选择列

选择

columns().deselect()

取消选择列

选择

columns().select()

选择列

选择

row().deselect()

取消选择单个行

选择

row().select()

选择单个行

选择

row().selected()

确定是否已选择行

选择

rows().deselect()

取消选择行

选择

rows().select()

选择行

选择

select()

在构造函数外部初始化选择

选择

select.blurable()

获取/设置表格项目选择选项的不可模糊状态

选择

select.info()

获取/设置信息摘要显示状态

选择

select.items()

获取/设置基于用户交互(行、列或单元格)的选择将会选择哪些项

选择

select.selectable()

获取/设置用于确定是否应选择行的函数

选择

select.selector()

获取/设置用于鼠标事件捕获的项目选择器

选择

select.style()

获取/设置最终用户在表格中选择项的样式

选择

select.toggleable()

获取/设置当单击已选择的项目时是否可以选择取消项目

StateRestore

stateRestore.activeStates()

获取当前所有活动状态的详细信息

StateRestore

stateRestore.state()

从 StateRestore 获取状态

StateRestore

stateRestore.state().load()

将 stateRestore 中的状态加载到表格

StateRestore

stateRestore.state().remove()

从 StateRestore 中移除状态

StateRestore

stateRestore.state().rename()

从 StateRestore 中重命名状态

StateRestore

stateRestore.state().save()

从 StateRestore 保存状态

StateRestore

stateRestore.state.add()

创建新状态

StateRestore

stateRestore.states()

从 StateRestore 中获取状态

StateRestore

stateRestore.states().remove()

从 StateRestore 中移除状态