API 插件

对于开发人员来说,与 DataTables 最常见的交互(当然除了表的初始化之外!)就是利用所提供的 API 方法。虽然允许进行广泛的代码交互,但通过利用下面提供的函数,可以极大地增强默认 API,以适合您的应用程序。

如何使用

要使用下面的一个插件 API 函数,您只需在加载 DataTables 库后、在初始化 DataTable 之前,将其包含到为您的页面提供的 JavaScript 中即可。

浏览器

直接在浏览器中加载 API 插件,只需要加载该插件的 JavaScript。例如,下面的代码使用 sum()(保存到文件中)

<script type="text/javascript" src="jquery.dataTables.js"></script>
<script type="text/javascript" src="sum().js"></script>
<script type="text/javascript">
    var table = new DataTable('#myTable');

    document
        .getElementById('button')
        .addEventListener('click', function () {
            alert('Column 4 total: ' + table.column(4).data().sum());
        });

    // or jQuery style:
    var table = $('#example').DataTable();

    $('#button').on('click', function () {
        alert('Column 4 total: ' + table.column(4).data().sum());
    });
</script>

可以在我们的 CDN 上找到可包含在浏览器中的插件。请参阅每个插件的详细信息页面,以获取完整的 CDN URL。

ES 模块

API 插件还作为 ES 模块提供,可以从 datatables.net-plugins.mjs 文件)中加载。您需要包含插件所需的函数。下面我们再次使用 sum() 的示例

import DataTable from 'datatables.net';
import 'datatables.net-plugins/api/sum().mjs';

var table = new DataTable('#myTable');

document
    .getElementById('button')
    .addEventListener('click', function () {
        alert('Column 4 total: ' + table.column(4).data().sum());
    });

CommonJS

如果您正在使用 CommonJS(即在较旧版本的 Node 或 Webpack 中),则可以加载 .js 文件,它将自动将插件添加到 DataTables 中。与 DataTables 核心和扩展一样,CommonJS 加载器提供了一个函数,您需要使用 window$/jQuery 对象调用该函数,例如

var $ = require('jquery');
var DataTable = require('datatables.net')(window, $);
require('datatables.net-plugins/api/sum().js')(window, $);

更多信息

如需了解有关使用 DataTables API 的更多信息,请参阅 手册的 API 部分。此外,在 示例部分 中提供了正在使用 API 插件的实时示例。

插件方法