{hero}

DataTable.feature.register()

自 DataTables 2.0 以来

创建一个可用于布局的新功能。

说明

DataTables 使用“功能”注册系统来定义可显示在表格周围且通常用于以某种方式控制表格的组件。内置的表格控件(如 pageLengthpaging)使用此系统,扩展(如 按钮)亦是如此。您还可以使用它为 DataTables 创建自己的功能插件,这些插件将与其 layout 选项一起使用。

定义自己的功能插件对于代码重用(即您想在多张表格上使用此功能)以及与社区共享十分有利。如果您想分享插件,请在论坛中发布相关帖子

此函数用于注册您自己的功能插件,为其提供将在 layout 中使用以引用它的名称,以及将定义其容器元素和行为的函数。

可以定义功能插件的选项,但应该有合理的详细信息,因为在使用 layout 时不需要选项。例如,以下两项对于使用名为 myToolbar 的功能是有效的

new DataTable('#myTable', {
    layout: {
        topStart: 'myToolbar'
    }
});
new DataTable('#myTable', {
    layout: {
        topStart: {
            myToolbar: {
                option1: true,
                option2: false
            }
        }
    }
});

定义的参数作为第二个参数传递到插件的构造函数中(如果没有提供值,它将为 null,例如在上面的第一个代码块中)。因此,对于上述内容,可以使用以下功能注册

DataTable.feature.register('myToolbar', function (settings, opts) {
    // Define defaults
    let options = Object.assign({
        option1: false,
        option2: false
    }, opts);

    let container = document.createElement('div');

    // do something with the options and container
    // ...

    return container;
});

类型

function register( name, construct )

说明
返回

不会返回任何值。