DataTables教程:使用JavaScript数组数据实现高级列搜索功能

雨丽大大_5575

雨丽大大_5575

2025-08-25

462人浏览

原创

DataTables教程:使用JavaScript数组数据实现高级列搜索功能

本教程详细指导如何在DataTables中,利用JavaScript数组数据初始化表格,并为每一列添加交互式的搜索过滤功能。内容涵盖数据与列定义的匹配、动态生成表头、以及通过initComplete回调实现列搜索框的完整逻辑,旨在帮助开发者构建功能强大的可搜索表格。

1. DataTables基础初始化与数据准备

在使用datatables时,如果数据源是javascript的数组(数组的数组形式),我们需要正确地将其与列定义(columns选项)结合。一个常见的错误是数据列数与列标题定义数量不匹配,或者语法错误。

数据与列定义示例:

const dataSet = [
  ['a', 'b', 'x'],
  ['c', 'd', 'y'],
  ['e', 'f', 'z']
];
const headers = [{
  'title': 'A'
}, {
  'title': 'B'
}, {
  'title': 'C'
}];

$(document).ready(function() {
  $('#example').DataTable({
    data: dataSet,
    columns: headers,
  });
});

注意事项:

  • dataSet中的每个内部数组代表一行数据,其元素数量必须与headers数组中定义的列数一致。
  • headers数组中的每个对象定义一个列,title属性用于设置列的标题。

2. 实现DataTables列搜索功能

为了在DataTables的每一列中添加独立的搜索框,我们需要利用DataTables的initComplete回调函数。此函数在表格完全初始化后执行,允许我们对DOM进行操作并绑定事件。

核心配置与逻辑:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
$(document).ready(function() {
  // 假设 dataSet 和 headers 已定义

  // 1. 如果HTML中没有<thead>,需要动态创建
  // 参考下一节“动态生成表头(<thead>)”

  // 克隆表头行并添加'filters'类,将其追加到表头
  $('#example thead tr')
    .clone(true)
    .addClass('filters')
    .appendTo('#example thead');

  var table = $('#example').DataTable({
    data: dataSet, // 绑定数据
    columns: headers, // 绑定列定义

    orderCellsTop: true, // 确保排序图标在顶部
    fixedHeader: true, // 可选:固定表头

    initComplete: function() {
      var api = this.api();

      // 遍历每一列
      api.columns().eq(0).each(function(colIdx) {
        // 获取当前列的筛选器单元格
        var cell = $('.filters th').eq(
          $(api.column(colIdx).header()).index()
        );
        var title = $(cell).text(); // 获取原始标题
        // 在筛选器单元格中插入文本输入框
        $(cell).html('<input type="text" placeholder="' + title + '">');

        // 为输入框绑定事件
        $('input', $('.filters th').eq($(api.column(colIdx).header()).index()))
          .off('keyup change') // 解绑可能存在的旧事件
          .on('change', function(e) {
            $(this).attr('title', $(this).val());
            var regexr = '({search})';
            var cursorPosition = this.selectionStart;

            // 对当前列进行搜索
            api
              .column(colIdx)
              .search(
                this.value != '' ?
                regexr.replace('{search}', '(((' + this.value + ')))') :
                '',
                this.value != '',
                this.value == ''
              )
              .draw(); // 重绘表格以显示搜索结果
          })
          .on('keyup', function(e) {
            e.stopPropagation(); // 阻止事件冒泡

            $(this).trigger('change'); // 触发change事件进行搜索
            // 可选:保持光标位置
            // $(this).focus()[0].setSelectionRange(cursorPosition, cursorPosition);
          });
      });
    },
  });
});<p><strong>关键点解析:</strong></p>
<ul>
<li>orderCellsTop: true:当有多个表头行时,确保排序功能应用于最顶部的表头。</li>
<li>fixedHeader: true:这是DataTables的一个扩展,用于固定表头,与列搜索功能结合使用时体验更佳。</li>
<li>initComplete:在此回调中,我们可以安全地操作已渲染的表格DOM。</li>
<li>api.columns().eq(0).each(function(colIdx) { ... }):遍历表格中的每一列。</li>
<li>$('.filters th').eq(...):选择新克隆的.filters行中的对应列单元格。</li>
<li>$(cell).html('<input type="text" placeholder="' + title + '">'):将搜索输入框添加到每个列的筛选器单元格中。</li>
<li>off('keyup change').on('change', ...).on('keyup', ...):<ul>
<li>off('keyup change'):在重新绑定事件之前,清除可能存在的旧事件监听器,避免重复触发。</li>
<li>on('change', function(e) { ... }):当输入框内容改变时(例如失去焦点或按回车),执行搜索。</li>
<li>on('keyup', function(e) { ... }):在每次按键抬起时触发change事件,实现实时搜索。e.stopPropagation()用于防止按键<a style="color:#f60; text-decoration:underline;" title="事件冒泡" href="https://m.php.cn/zt/16487.html" target="_blank">事件冒泡</a>到DataTables的其他事件<a style="color:#f60; text-decoration:underline;" title="处理器" href="https://m.php.cn/zt/16030.html" target="_blank">处理器</a>。</li>
</ul>
</li>
<li>api.column(colIdx).search(...):这是DataTables API中用于对特定列进行搜索的方法。参数包括搜索值、是否使用<a style="color:#f60; text-decoration:underline;" title="正则表达式" href="https://m.php.cn/zt/15947.html" target="_blank">正则表达式</a>、是否智能搜索等。</li>
<li>draw():在搜索条件改变后,必须调用此方法来重新绘制表格,以应用新的过滤条件。</li>
</ul>
<h3>3. 动态生成表头(<thead>)<p>如果你的HTML表格结构最初没有<thead>标签,或者<thead>中没有包含足够的<th>元素来匹配你的列定义,那么上述的列搜索代码将无法正常工作,因为$('#example thead tr').clone(true)找不到目标。在这种情况下,我们需要在DataTables初始化之前,动态地创建并添加<thead>。<p><strong>HTML表格示例(无<thead>):<pre class="brush:php;toolbar:false;">

动态生成的JavaScript代码:

// 假设 headers 已定义
var th = '<thead><tr>';
headers.forEach(header => th = th + '<th>' + header.title + '</th>');
th = th + '</tr></thead>';
$(th).appendTo('#example');

这段代码会根据headers数组中的定义,生成一个包含所有列标题的结构,并将其追加到#example表格中。这样,后续的DataTables初始化和列搜索逻辑就能找到正确的表头元素进行操作。

4. 完整示例与注意事项

将上述所有组件整合,我们可以构建一个完整的、功能齐全的DataTables列搜索示例。

HTML结构 (index.html):



  <meta charset="UTF-8"><title>DataTables列搜索教程</title><script src="https://code.jquery.com/jquery-3.5.1.js"></script><script src="https://cdn.datatables.net/1.10.22/js/jquery.dataTables.js"></script><link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.10.22/css/jquery.dataTables.css"><!-- DataTables FixedHeader 扩展的CSS,如果使用fixedHeader:true则需要 --><link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/fixedheader/3.1.7/css/fixedHeader.dataTables.min.css"><script src="https://cdn.datatables.net/fixedheader/3.1.7/js/dataTables.fixedHeader.min.js"></script><style>
    /* 可选:为筛选器行添加一些样式 */
    .filters input {
      width: 100%;
      box-sizing: border-box;
      padding: 3px;
      border: 1px solid #ccc;
      border-radius: 3px;
    }
  </style><div style="margin: 20px;">
    <h2>DataTables高级列搜索示例</h2>
    <table id="example" class="display dataTable cell-border" style="width:100%"><!-- <thead> 将由JavaScript动态生成 --></table>
</div>

  <script>
    $(document).ready(function() {
      const dataSet = [
        ['Apple', 'Red', 'Fruit'],
        ['Banana', 'Yellow', 'Fruit'],
        ['Carrot', 'Orange', 'Vegetable'],
        ['Grape', 'Purple', 'Fruit'],
        ['Spinach', 'Green', 'Vegetable']
      ];
      const headers = [{
        'title': '名称'
      }, {
        'title': '颜色'
      }, {
        'title': '分类'
      }];

      // 动态生成表头 <thead>
      var th = '<thead><tr>';
      headers.forEach(header => th = th + '<th>' + header.title + '');
      th = th + '</script>
'; $(th).appendTo('#example'); // 克隆表头行并添加'filters'类,将其追加到表头 $('#example thead tr') .clone(true) .addClass('filters') .appendTo('#example thead'); var table = $('#example').DataTable({ data: dataSet, columns: headers, orderCellsTop: true, // 确保排序图标在顶部 fixedHeader: true, // 启用固定表头 initComplete: function() { var api = this.api(); // 遍历每一列 api.columns().eq(0).each(function(colIdx) { // 获取当前列的筛选器单元格 var cell = $('.filters th').eq( $(api.column(colIdx).header()).index() ); var title = $(cell).text(); // 获取原始标题 // 在筛选器单元格中插入文本输入框 $(cell).html(''); // 为输入框绑定事件 $('input', $('.filters th').eq($(api.column(colIdx).header()).index())) .off('keyup change') // 解绑可能存在的旧事件 .on('change', function(e) { $(this).attr('title', $(this).val()); var regexr = '({search})'; // 示例中使用占位符,实际DataTables会处理 // 对当前列进行搜索 api .column(colIdx) .search( this.value != '' ? regexr.replace('{search}', '(((' + this.value + ')))') : // 这里的regexr替换逻辑是DataTables内部处理的一部分,通常直接传值即可 '', this.value != '', // 是否使用正则表达式 this.value == '' // 是否智能搜索 ) .draw(); // 重绘表格以显示搜索结果 }) .on('keyup', function(e) { e.stopPropagation(); // 阻止事件冒泡 $(this).trigger('change'); // 触发change事件进行实时搜索 }); }); }, }); });

总结: 通过本教程,我们学习了如何利用JavaScript数组数据初始化DataTables,并为表格的每一列实现高级的搜索过滤功能。关键步骤包括确保数据与列定义的匹配、动态生成以支持表头操作,以及在initComplete回调中通过DataTables API操作DOM并绑定搜索事件。遵循这些步骤,开发者可以创建出用户体验更佳、功能更强大的数据表格。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4676

8

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

2023.07.05

3161

4

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8782

9

java正则表达式匹配字符串
java正则表达式匹配字符串

在Java中,我们可以使用正则表达式来匹配字符串。本专题为大家带来java正则表达式匹配字符串的相关内容,帮助大家解决问题。

2023.08.11

812

5

正则表达式空格
正则表达式空格

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。本专题为大家提供正则表达式相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

520

5

Python爬虫获取数据的方法
Python爬虫获取数据的方法

Python爬虫可以通过请求库发送HTTP请求、解析库解析HTML、正则表达式提取数据,或使用数据抓取框架来获取数据。更多关于Python爬虫相关知识。详情阅读本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

693

12

正则表达式空格如何表示
正则表达式空格如何表示

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。想了解更多正则表达式空格怎么表示的内容,可以访问下面的文章。

2023.11.17

406

3

正则表达式中如何匹配数字
正则表达式中如何匹配数字

正则表达式中可以通过匹配单个数字、匹配多个数字、匹配固定长度的数字、匹配整数和小数、匹配负数和匹配科学计数法表示的数字的方法匹配数字。更多关于正则表达式的相关知识详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.12.06

739

7

php正则表达式有哪些
php正则表达式有哪些

php正则表达式有"/pattern/"、"^"、"$"、"."、"[]"、"[^]"、"[a-z]"、"[A-Z]"、"[0-9]"、"\d"、"\D"、"\w"、"\W"、&a

2024.02.23

312

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.6万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 6.1万人学习

CSS教程
CSS教程

共754课时 | 99.7万人学习