DataTable文档
DataTable文档
DreamCollector一、DataTable
二、选项（Option）
有关初始化选项信息，请参阅:选项手册
1 | //例子： |
三、API（JavaScript）
有关操作的信息，请参阅：API 手册
| 数据表 - 核心 | 描述 |
|---|---|
| $()) | 对整个表执行 jQuery 选择操作 |
| ajax | Ajax 方法的命名空间 |
| ajax.json()) | 获取从最后一次 Ajax 请求 DataTables 中获取的最新 JSON 数据 |
| ajax.params()) | 获取上次Ajax请求中DataTables提交给服务器的数据 |
| ajax.reload()) | 从 Ajax 数据源重新加载表数据 |
| ajax.url()) | 获取/设置 DataTables 用于 Ajax 获取数据的 URL |
| ajax.url().load().load()) | 从新设置的数据源 URL 加载数据 |
| clear()) | 清除所有数据表 |
| data()) | 获取整个表的数据 |
| destroy()) | 销毁当前上下文中的数据表 |
| draw()) | 重新绘制表格 |
| i18n()) | 国际化令牌查找 |
| init()) | 获取用于表的初始化选项 |
| off()) | 表事件删除 |
| on()) | 表事件监听器 |
| one()) | 侦听一次表事件，然后删除侦听器 |
| order()) | 获取/设置应用于表的排序 |
| order.fixed()) | 获取/设置应用于表格的固定顺序 |
| order.listener()) | 为给定的列向元素添加排序侦听器 |
| page()) | 获取/设置表的当前页 |
| page.info()) | 获取有关表的分页信息 |
| page.len()) | 获取/设置表格的页长 |
| search()) | 在表中搜索数据 |
| settings()) | 获取表的设置对象 |
| state()) | 获取表格最后保存的状态 |
| state.clear()) | 清除表的保存状态 |
| state.loaded()) | 获取初始化期间加载的表状态 |
| state.save()) | 触发状态保存 |
| 数据表 - 单元格 | |
| cell()) | 从表格中选择一个单元格 |
| cell().cache().cache()) | 获取选定单元格的 DataTables 缓存数据 |
| cell().data().data()) | 获取/设置选定单元格的数据 |
| cell().index().index()) | 获取有关选定单元格的索引信息 |
| cell().invalidate().invalidate()) | 使选定单元格的 DataTables 中保存的数据无效 |
| cell().node().node()) | 获取选定单元格的 DOM 元素 |
| cell().render().render()) | 获取单元格的渲染数据 |
| cells()) | 从表格中选择多个单元格 |
| cells().cache().cache()) | 获取选定单元格的 DataTables 缓存数据 |
| cells().data().data()) | 获取选定单元格的数据 |
| cells().every().every()) | 迭代每个选定的单元格，并将函数上下文设置为有问题的单元格 |
| cells().indexes().indexes()) | 获取有关选定单元格的索引信息 |
| cells().invalidate().invalidate()) | 使选定单元格的 DataTables 中保存的数据无效 |
| cells().nodes().nodes()) | 获取选定单元格的 DOM 元素 |
| cells().render().render()) | 获取单元格集合的渲染数据 |
| 数据表 - 列 | |
| column()) | 从表中选择单个列 |
| column().cache().cache()) | 获取所选列的 DataTables 缓存数据 |
| column().data().data()) | 获取所选列中单元格的数据 |
| column().dataSrc().dataSrc()) | 获取所选列的数据源属性 |
| column().footer().footer()) | 获取所选列的页脚节点 |
| column().header().header()) | 获取所选列的标题节点 |
| column().index().index()) | 获取所选列的列索引 |
| column().nodes().nodes()) | 获取所选列的单元格节点 |
| column().order().order()) | 按所选列对表格进行排序 |
| column().search().search()) | 在所选列中搜索数据 |
| column().visible().visible()) | 获取/设置单个选定列的可见性 |
| column.index()) | 在列索引格式之间转换 |
| columns()) | 从表中选择多个列 |
| columns().cache().cache()) | 获取所选列的 DataTables 缓存数据 |
| columns().data().data()) | 获取所选列中单元格的数据 |
| columns().dataSrc().dataSrc()) | 获取选定列的数据源属性 |
| columns().every().every()) | 迭代每个选定的列，并将函数上下文设置为有问题的列 |
| columns().footer().footer()) | 获取所选列的页脚节点 |
| columns().header().header()) | 获取选定列的标题节点 |
| columns().indexes().indexes()) | 获取选定列的列索引 |
| columns().nodes().nodes()) | 获取选定列的单元格节点 |
| columns().order().order()) | 按选定的列对表格进行排序 |
| columns().search().search()) | 在选定列中搜索数据 |
| columns().visible().visible()) | 获取/设置选定列的可见性 |
| columns.adjust()) | 重新计算列宽 |
| 数据表 - 行 | |
| row()) | 从表中选择一行 |
| row().cache().cache()) | 获取所选行的 DataTables 缓存数据 |
| row().child.child) | 行子方法命名空间 |
| row().child().child()) | 获取/设置选定主表行的子行 |
| row().child().hide().child().hide()) | 创建新子行后隐藏子行 |
| row().child().remove().child().remove()) | 销毁选定父行的子行 |
| row().child().show().child().show()) | 使新定义的子行可见 |
| row().child.hide().child.hide()) | 隐藏父行的子行 |
| row().child.isShown().child.isShown()) | 检查父行的子行是否可见 |
| row().child.remove().child.remove()) | 销毁选定父行的子行 |
| row().child.show().child.show()) | 使父行的子行可见 |
| row().data().data()) | 获取/设置所选行的数据 |
| row().id().id()) | 获取所选行的 id |
| row().index().index()) | 获取所选行的行索引 |
| row().invalidate().invalidate()) | 使所选行的 DataTables 中保存的数据无效 |
| row().node().node()) | 获取TR所选行的行节点 |
| row().remove().remove()) | 从 DataTable 中删除选定的行 |
| row.add()) | 向表中添加新行 |
| rows()) | 从表中选择多行 |
| rows().cache().cache()) | 获取所选行的 DataTables 缓存数据 |
| rows().data().data()) | 获取所选行的数据 |
| rows().every().every()) | 迭代每个选定的行，并将函数上下文设置为有问题的行 |
| rows().ids().ids()) | 获取所选行的 ID |
| rows().indexes().indexes()) | 获取所选行的行索引 |
| rows().invalidate().invalidate()) | 使选定行的 DataTables 中保存的数据无效 |
| rows().nodes().nodes()) | 获取TR所选行的行节点 |
| rows().remove().remove()) | 从 DataTable 中删除选定的行 |
| rows.add()) | 向表中添加多个新行 |
| 数据表 - 表 | |
| table()) | 根据 API 上下文中的选择器选择表 |
| table().body().body()) | tbody在 API 的上下文中获取表的节点 |
| table().container().container()) | 在 API 的上下文中获取div表的容器节点 |
| table().footer().footer()) | tfoot在 API 的上下文中获取表的节点 |
| table().header().header()) | thead在 API 的上下文中获取表的节点 |
| table().node().node()) | table在 API 的上下文中获取表的节点 |
| tables()) | 根据 API 上下文中的选择器选择表 |
| tables().body().body()) | 获取tbodyAPI 上下文中表的节点 |
| tables().containers().containers()) | 获取divAPI 上下文中表的容器节点 |
| tables().footer().footer()) | 获取tfootAPI 上下文中表的节点 |
| tables().header().header()) | 获取theadAPI 上下文中表的节点 |
| tables().nodes().nodes()) | 获取tableAPI 上下文中表的节点 |
| 数据表 - 实用程序 | |
| any()) | 确定结果集中是否有任何条目 |
| concat()) | 组合多个 API 实例以创建一个新实例 |
| count()) | 获取 API 实例中包含的元素数量 |
| each()) | 遍历 API 结果集的内容 |
| eq()) | 将 Api 实例缩减为单个上下文和结果集 |
| filter()) | 使用结果集中通过给定测试的所有元素创建一个新的 API 实例 |
| flatten()) | 将二维数组结构化 API 实例展平为一维数组结构 |
| indexOf()) | 在 API 实例的结果集中查找值的第一个实例 |
| iterator()) | 迭代表、行、列或单元格索引的结果集 |
| join()) | 将结果集中的元素连接成一个字符串 |
| lastIndexOf()) | 在 API 实例的结果集中查找值的最后一个实例 |
| length | API 实例结果集中的元素数 |
| map()) | 使用回调函数返回的值定义的结果集创建一个新的 API 实例 |
| pluck()) | 使用当前结果集中对象的属性值创建一个新的 API 实例 |
| pop()) | 从 API 实例的结果集中删除最后一项 |
| push()) | 将一项或多项添加到 API 实例结果集的末尾 |
| reduce()) | 对累加器和 Api 结果集中的每个元素应用回调函数（从左到右） |
| reduceRight()) | 对累加器和 Api 结果集中的每个元素应用回调函数（从右到左） |
| reverse()) | 反转 API 实例的结果集 |
| shift()) | 从 API 实例的结果集中删除第一项 |
| slice()) | 创建 API 实例的独立副本 |
| sort()) | 对 API 实例的结果集的元素进行排序 |
| splice()) | 修改 Api 实例结果集的内容，根据需要在其中添加或删除项目 |
| to$()) | 将 API 实例转换为 jQuery 对象，并将实例结果集中的对象放在 jQuery 结果集中 |
| toArray()) | 从 API 实例创建本机 Javascript 数组对象 |
| toJQuery()) | 将 API 实例转换为 jQuery 对象，并将实例结果集中的对象放在 jQuery 结果集中 |
| unique()) | 创建一个新的 API 实例，该实例仅包含来自实例结果集中元素的唯一项 |
| unshift()) | 将一项或多项添加到 API 实例结果集的开头 |
| 数据表 - 静态 | |
| DataTable.isDataTable()) | 检查表节点是否为 DataTable |
| DataTable.tables()) | 获取页面上的所有DataTables |
| DataTable.util.escapeRegex()) | 转义正则表达式字符串中的特殊字符 |
| DataTable.util.get()) | 从描述符创建读取函数 |
| DataTable.util.set()) | 从描述符创建写入函数 |
| DataTable.util.throttle()) | 限制对方法的调用以降低调用频率 |
| DataTable.versionCheck()) | 版本号兼容性检查功能 |
| 自动填充 | |
| autoFill().disable().disable()) | 禁用自动填充的交互 |
| autoFill().enable().enable()) | 启用或禁用自动填充的交互 |
| autoFill().enabled().enabled()) | 确定自动填充是启用还是禁用 |
| 纽扣 | |
| $.fn.dataTable.fileSave()) | 保存在客户端创建的文件 |
| button()) | 选择一个按钮 |
| button().action().action()) | 获取/设置选中按钮的动作函数 |
| button().active().active()) | 获取/设置选中按钮的激活状态 |
| button().add().add()) | 创建一个新按钮并将其添加到文档中 |
| button().collectionRebuild().collectionRebuild()) | 重建按钮集合 |
| button().disable().disable()) | 禁用选定的按钮 |
| button().enable().enable()) | 启用/禁用所选按钮 |
| button().index().index()) | 获取节点的索引 |
| button().node().node()) | 获取所选按钮的按钮节点 |
| button().popover().popover()) | 显示按钮的弹出框，允许额外的用户输入 |
| button().processing().processing()) | 获取/设置按钮的处理状态 |
| button().remove().remove()) | 移除和删除选中的按钮 |
| button().text().text()) | 获取/设置所选按钮的文本 |
| button().trigger().trigger()) | 触发选中按钮的动作 |
| buttons()) | 选择一个或多个按钮 |
| buttons().action().action()) | 获取/设置所选按钮的操作功能 |
| buttons().active().active()) | 设置选定按钮的活动状态 |
| buttons().collectionRebuild().collectionRebuild()) | 重建按钮集合 |
| buttons().container().container()) | 获取单个 Buttons 实例的容器元素 |
| buttons().containers().containers()) | 获取一个或多个按钮实例的容器元素 |
| buttons().destroy().destroy()) | 销毁一个或多个按钮实例并从文档中移除 |
| buttons().disable().disable()) | 禁用选定的按钮 |
| buttons().enable().enable()) | 启用/禁用所选按钮 |
| buttons().nodes().nodes()) | 获取所选按钮的按钮节点 |
| buttons().processing().processing()) | 设置多个按钮的处理状态 |
| buttons().remove().remove()) | 移除和删除选中的按钮 |
| buttons().text().text()) | 获取/设置选定按钮的文本 |
| buttons().trigger().trigger()) | 触发所选按钮的动作 |
| buttons.exportData()) | 从适合导出的DataTable中获取数据 |
| buttons.exportInfo()) | 获取许多不同按钮类型共有的导出元信息 |
| buttons.info()) | 在模态框中显示和隐藏最终用户的信息 |
| 颜色重新排序 | |
| colReorder.disable()) | 禁用 ColReorder 的交互 |
| colReorder.enable()) | 启用或禁用 ColReorder 的交互 |
| colReorder.move()) | 以编程方式移动列 |
| colReorder.order()) | 获取/设置列顺序 |
| colReorder.reset()) | 恢复加载的列顺序 |
| colReorder.transpose()) | 将一个或多个列索引与当前索引和原始索引相互转换 |
| 固定列 | |
| fixedColumns()) | FixedColumns 方法的命名空间 |
| fixedColumns().left().left()) | 获取/设置左侧 FixedColumns 的数量 |
| fixedColumns().right().right()) | 获取/设置右 FixedColumns 的数量 |
| 固定头 | |
| fixedHeader.adjust()) | 重新计算表格位置并重绘固定元素 |
| fixedHeader.disable()) | 禁用固定元素 |
| fixedHeader.enable()) | 启用/禁用固定元素 |
| fixedHeader.enabled()) | 获取当前启用状态 |
| fixedHeader.footerOffset()) | 获取/设置固定页脚的偏移量 |
| fixedHeader.headerOffset()) | 获取/设置固定头的偏移量 |
| 键表 | |
| cell().focus().focus()) | 专注于一个细胞 |
| cell.blur()) | 从桌子上模糊焦点 |
| keys.disable()) | 禁用 KeyTable 的交互（鼠标和键盘） |
| keys.enable()) | 启用或禁用 KeyTable 的交互（鼠标和键盘） |
| keys.enabled()) | 确定表的 KeyTable 启用状态 |
| keys.move()) | 将焦点移动到相邻单元格 |
| 响应式 | |
| column().responsiveHidden().responsiveHidden()) | 获取表中列的响应可见性状态 |
| columns().responsiveHidden().responsiveHidden()) | 获取表中列的响应可见性状态 |
| responsive.hasHidden()) | 确定 Responsive 是否隐藏了表中的任何列 |
| responsive.index()) | li从详细信息元素中获取单元格索引 |
| responsive.rebuild()) | 根据列标题单元格的类信息重新计算列断点 |
| responsive.recalc()) | 显示变化后重新计算 responsive 使用的宽度 |
| 行组 | |
| rowGroup().dataSrc().dataSrc()) | 获取/设置行分组的数据源 |
| rowGroup().disable().disable()) | 禁用 RowGroup 与表格的交互 |
| rowGroup().enable().enable()) | 启用或禁用 RowGroup 与表格的交互 |
| rowGroup().enabled().enabled()) | 确定是否在表上启用了 RowGroup |
| 行重新排序 | |
| rowReorder.disable()) | 禁用用户对行重新排序的能力 |
| rowReorder.enable()) | 启用/禁用用户重新排序行的能力 |
| 滚动条 | |
| row().scrollTo().scrollTo()) | 滚动到特定行 |
| scroller.measure()) | 重新计算 Scroller 使用的缓存测量值 |
| scroller.page()) | 获取有关当前正在显示的行的信息 |
| scroller.toPosition()) | 滚动到特定的行显示索引 |
| 搜索生成器 | |
| searchBuilder.container()) | 返回 SearchBuilder 容器的节点 |
| searchBuilder.getDetails()) | 获取当前搜索设置的详细信息 |
| searchBuilder.rebuild()) | 将搜索重建到给定状态 |
| 搜索窗格 | |
| searchPanes.clearSelections()) | 清除所有窗格中的选择 |
| searchPanes.container()) | 返回窗格容器的节点 |
| searchPanes.rebuildPane()) | 重建窗格，从表中重新收集选项 |
| searchPanes.resizePanes()) | 调整所有窗格的大小以适当地填充 SearchPanes 容器 |
| 选择 | |
| cell().deselect().deselect()) | 取消选择单个单元格 |
| cell().select().select()) | 选择单个单元格 |
| cell().selected().selected()) | 判断一个单元格是否被选中 |
| cells().deselect().deselect()) | 取消选择单元格 |
| cells().select().select()) | 选择单元格 |
| column().deselect().deselect()) | 取消选择单个列 |
| column().select().select()) | 选择单个列 |
| column().selected().selected()) | 确定是否已选择列 |
| columns().deselect().deselect()) | 取消选择列 |
| columns().select().select()) | 选择列 |
| row().deselect().deselect()) | 取消选择单行 |
| row().select().select()) | 选择单行 |
| row().selected().selected()) | 确定是否已选择行 |
| rows().deselect().deselect()) | 取消选择行 |
| rows().select().select()) | 选择行 |
| select()) | 从构造函数外部初始化选择 |
| select.blurable()) | 获取/设置表格的项目选择选项的可模糊状态 |
| select.info()) | 获取/设置信息汇总显示状态 |
| select.items()) | 获取/设置 Select 将根据用户交互选择的项目（行、列或单元格） |
| select.selector()) | 获取/设置鼠标事件捕获的项目选择器 |
| select.style()) | 获取/设置最终用户可以选择表格中的项目的样式 |
| select.toggleable()) | 获取/设置单击选定项目时可以取消选择项目的行为 |
| 状态恢复 | |
| stateRestore.activeStates()) | 获取所有当前活动状态的详细信息 |
| stateRestore.state()) | 从 StateRestore 获取状态 |
| stateRestore.state().load().load()) | 将 StateRestore 中的状态加载到表中 |
| stateRestore.state().remove().remove()) | 从 StateRestore 中删除状态 |
| stateRestore.state().rename().rename()) | 从 StateRestore 重命名状态 |
| stateRestore.state().save().save()) | 从 StateRestore 保存状态 |
| stateRestore.state.add()) | 创建一个新状态 |
| stateRestore.states()) | 从 StateRestore 获取状态 |
| stateRestore.states().remove().remove()) | 从 StateRestore 中删除状态 |
四、事件（Function）
有关自定义事件的信息，请参阅:事件手册
1 | //draw监听事件例子： |
| 数据表 | 描述 |
|---|---|
| childRow | 已从表中添加或删除子行 |
| column-sizing | 列调整事件 - 在重新计算列宽时触发 |
| column-visibility | 列可见性事件 - 当列的可见性改变时触发 |
| destroy | 表销毁事件 - 当表被销毁时触发 |
| draw | 平局事件 - 一旦牌桌完成平局就触发 |
| error | 错误事件 - DataTables 处理数据期间发生错误 |
| init | 初始化完成事件 - 当 DataTables 完全初始化并加载数据时触发 |
| length | 页面长度更改事件 - 当页面长度更改时触发 |
| order | order 事件 - 当表中包含的数据被排序时触发 |
| page | 页面更改事件 - 当表的分页更新时触发 |
| preDraw | 预绘制事件 - 在表格即将重绘时触发 |
| preInit | 初始化开始事件 - 在数据加载之前立即触发 |
| preXhr | Ajax 事件 - 在发出 Ajax 请求之前触发 |
| processing | 处理事件 - 在 DataTables 处理数据时触发 |
| requestChild | DataTables 想要显示一个子行 |
| search | 搜索事件 - 过滤表时触发 |
| stateLoadParams | 状态加载事件 - 从存储加载状态时触发 |
| stateLoaded | 状态加载事件 - 一旦状态被加载和应用就被触发 |
| stateSaveParams | 状态保存事件 - 保存表状态信息时触发 |
| xhr | Ajax 事件 - 当 Ajax 请求完成时触发 |
| 自动填充 | |
| autoFill | 自动填充操作已完成 |
| preAutoFill | 即将对表格应用自动填充操作 |
| 纽扣 | |
| buttons-action | 按钮的动作方法已被触发 |
| buttons-processing | 按钮的处理状态已更改 |
| 颜色重新排序 | |
| column-reorder | 列已由最终用户或 API 重新排序 |
| 键表 | |
| key | 已在表上检测到键事件，但KeyTable 未处理 |
| key-blur | KeyTable 模糊了单元格的焦点 |
| key-focus | KeyTable 聚焦了一个单元格 |
| key-refocus | KeyTable 重新聚焦了一个单元格 |
| key-return-submit | Return 键用于提交编辑器内联编辑 |
| 响应式 | |
| responsive-display | 行的详细信息已显示、更新或隐藏 |
| responsive-resize | 由于调整大小，响应式显示的列已更改 |
| 行组 | |
| rowgroup-datasrc | 分组数据属性已更改 |
| 行重新排序 | |
| pre-row-reorder | 最终用户已启动行重新排序操作 |
| row-reorder | 行已由最终用户重新排序 |
| row-reordered | 在最终用户重新排序行之后 |
| 搜索生成器 | |
| dtsb-inserted | 来自 init 函数的元素已插入 dom |
| 选择 | |
| deselect | 项目（行、列或单元格）已被取消选择 |
| select | 已选择项目（行、列或单元格） |
| selectItems | 选择项目类型更改事件 |
| selectStyle | 选择样式更改事件 |
| user-select | 用户操作将导致在表格中选择项目 |
| 状态恢复 | |
| stateRestore-change | 当添加、删除或更改 StateRestore 中的状态时触发 |
评论
匿名评论隐私政策
✅ 你无需删除空行，直接评论以获取最佳展示效果
