DataTables.Api

DataTables API 对象实例。

描述

DataTables API 让您能通过其实现的丰富方法程序化地控制一个或多个 DataTable 表格。API 实现的很多方法也会返回 API 实例，这提供了链式方法的能力，令 API 既精简又极富表现力。因此，我们定义此 DataTables.Api 数据类型，在方法以其返回值提供一个 API 实例时明确表述出来。

API 结构

API 对象类似于数组，因为它具有 length 属性，其结果集中的元素可以使用 Javascript 数组符号 ([]) 访问，并且它提供了许多 (虽然不是全部) 的与 array (例如 push() 和 indexOf()) 相同的方法。

访问 API

可以通过以下三种方法创建新 API 实例

$( selector ).DataTable(); - DataTables 构造函数
$( selector ).dataTable().api(); - DataTables jQuery 构造函数
new $.fn.dataTable.Api( selector ); - 直接初始化

每个结果都是包含其上下文中的选择器所找到的表格的 DataTables API 对象实例。在所有这三种情况下，selector 都是一个 jQuery 选择器。

注意 $( selector ).DataTable() 和 $( selector ).dataTable() 之间的区别非常重要。前者返回一个 DataTables API 实例，而后者返回一个 jQuery 对象。jQuery 对象已添加一个 api() 方法，因此您可以轻松访问 API，但 jQuery 对象对于操作表格节点非常有用，就像您使用任何其他 jQuery 实例时一样 (例如使用 addClass() 等)。

$( selector ).DataTable(); 示例

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

// Search for a data point
table.search( 'Fiona' ).draw();

$( selector ).dataTable(); 示例

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

// Jump to the next page of data
table.page('next').draw(false);

new $.fn.dataTable.Api( selector );

var table = new $.fn.dataTable.Api( '#myTable' );

// Get data from the first row
var data = table.rows().data()[0]; // same as row(0).data()