DataTables.Api

DataTables API 物件實例。

描述

DataTables API 透過它所實作的廣泛方法陣列，提供以程式化方式控制一個或多個 DataTable 表格的能力。 API 實作的許多方法本身會傳回一個 API 實例，從而能夠鏈結方法，因此允許 API 既緊湊又富有表現力。因此，當方法提供 API 實例作為其傳回值時，我們定義此 DataTables.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 物件。 api() 方法會新增到 jQuery 物件，因此您可以輕鬆存取 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()