API
DataTables 具有廣泛的 API,可用於存取表格中包含的資料,並在表格初始化完成後以其他方式操作表格。 DataTables API 的設計旨在反映表格中資料的結構,以及您通常如何透過 API 與表格互動。它也可以透過擴充功能和外掛來擴充,以提供額外的功能和操作。
API 可以透過以下方法存取
new DataTable.Api( selector );
$( selector ).DataTable();
$( selector ).dataTable().api();
每個方法的回傳值都是 DataTables API 物件的實例,該物件在其上下文中具有選取器找到的表格。如果您使用 jQuery,請務必注意 $( selector ).DataTable()
和 $( selector ).dataTable()
之間的差異。 前者回傳 DataTables API 實例,而後者回傳 jQuery 物件。
如需 DataTables API 如何運作的一般資訊,包括其串聯、如何使用多個表格以及本參考中使用的術語定義,請參考 API 手冊。
函式庫 | 名稱 | 摘要 |
---|---|---|
DataTables - 核心 | 對完整表格執行 jQuery 選取動作。 | |
DataTables - 核心 | Ajax 方法的命名空間 | |
DataTables - 核心 | 取得 DataTables 在上次 Ajax 請求中獲得的最新 JSON 資料 | |
DataTables - 核心 | 取得 DataTables 在上次 Ajax 請求中提交至伺服器的資料 | |
DataTables - 核心 | 從 Ajax 資料來源重新載入表格資料 | |
DataTables - 核心 | 取得/設定 DataTables 用於 Ajax 擷取資料的 URL | |
DataTables - 核心 | 從新設定的資料來源 URL 載入資料 | |
DataTables - 核心 | 清除表格中的所有資料。 | |
DataTables - 核心 | 取得欄的初始化選項。 | |
DataTables - 核心 | 取得/設定要套用至欄的具名搜尋。 | |
DataTables - 核心 | 取得選定欄的初始化選項。 | |
DataTables - 核心 | 取得/設定要套用至欄的具名搜尋。 | |
DataTables - 核心 | 取得整個表格的資料。 | |
DataTables - 核心 | 銷毀目前上下文中的 DataTables。 | |
DataTables - 核心 | 重新繪製表格。 | |
DataTables - 核心 | 國際化權杖查閱。 | |
DataTables - 核心 | 取得表格使用的初始化選項。 | |
DataTables - 核心 | 表格事件移除。 | |
DataTables - 核心 | 表格事件監聽器。 | |
DataTables - 核心 | 監聽一次表格事件,然後移除監聽器。 | |
DataTables - 核心 | 取得/設定套用至表格的排序。 | |
DataTables - 核心 | 取得/設定套用至表格的固定排序。 | |
DataTables - 核心 | 將排序監聽器新增至元素,用於指定的欄。 | |
DataTables - 核心 | 取得/設定表格的目前頁面。 | |
DataTables - 核心 | 取得表格的分頁資訊 | |
DataTables - 核心 | 取得/設定表格的頁面長度。 | |
DataTables - 核心 | 設定 DataTable 的處理指示器狀態。 | |
DataTables - 核心 | 在表格中搜尋資料。 | |
DataTables - 核心 | 取得/設定要套用至表格的具名搜尋。 | |
DataTables - 核心 | 取得表格的設定物件 | |
DataTables - 核心 | 取得/設定表格的狀態 | |
DataTables - 核心 | 清除表格的已儲存狀態。 | |
DataTables - 核心 | 取得初始化期間載入的表格狀態。 | |
DataTables - 核心 | 觸發狀態儲存。 | |
DataTables - 核心 | 觸發事件。 | |
DataTables - 儲存格 | 從表格中選取單一儲存格。 | |
DataTables - 儲存格 | 取得選取儲存格的 DataTables 快取資料 | |
DataTables - 儲存格 | 取得/設定選取儲存格的資料 | |
DataTables - 儲存格 | 取得選取儲存格的索引資訊 | |
DataTables - 儲存格 | 使 DataTables 中保存的選取儲存格資料失效 | |
DataTables - 儲存格 | 取得選取儲存格的 DOM 元素 | |
DataTables - 儲存格 | 取得儲存格的轉譯資料 | |
DataTables - 儲存格 | 從表格中選取多個儲存格。 | |
DataTables - 儲存格 | 取得選取儲存格的 DataTables 快取資料 | |
DataTables - 儲存格 | 取得選取儲存格的資料 | |
DataTables - 儲存格 | 反覆運算每個選取的儲存格,並將函式內容設定為有問題的儲存格。 | |
DataTables - 儲存格 | 取得選取儲存格的索引資訊 | |
DataTables - 儲存格 | 使 DataTables 中保存的選取儲存格資料失效 | |
DataTables - 儲存格 | 取得選取儲存格的 DOM 元素 | |
DataTables - 儲存格 | 取得儲存格集合的轉譯資料 | |
DataTables - 欄 | 從表格中選取單一欄。 | |
DataTables - 欄 | 取得選取欄的 DataTables 快取資料。 | |
DataTables - 欄 | 取得選取欄中儲存格的資料。 | |
DataTables - 欄 | 取得選取欄的資料來源屬性。 | |
DataTables - 欄 | 取得選取欄的頁尾節點。 | |
DataTables - 欄 | 取得選取欄的頁首節點。 | |
DataTables - 欄 | 取得選取欄的欄索引。 | |
DataTables - 欄 | 取得選取欄的儲存格節點。 | |
DataTables - 欄 | 依選取欄排序表格。 | |
DataTables - 欄 | 取得有關欄的排序狀態的資訊。 | |
DataTables - 欄 | 取得欄的轉譯資料 | |
DataTables - 欄 | 在選取欄中搜尋資料。 | |
DataTables - 欄 | 取得/設定欄的標題。 | |
DataTables - 欄 | 取得欄的資料類型。 | |
DataTables - 欄 | 取得/設定單一選取欄的顯示狀態。 | |
DataTables - 欄 | 取得欄的寬度。 | |
DataTables - 欄 | 在欄索引格式之間轉換 | |
DataTables - 欄 | 從表格中選取多個欄。 | |
DataTables - 欄 | 取得選取欄的 DataTables 快取資料。 | |
DataTables - 欄 | 取得選取欄中儲存格的資料。 | |
DataTables - 欄 | 取得選取欄的資料來源屬性。 | |
DataTables - 欄 | 反覆運算每個選取的欄,並將函式內容設定為有問題的欄。 | |
DataTables - 欄 | 取得選取欄的頁尾節點。 | |
DataTables - 欄 | 取得選取欄的頁首節點。 | |
DataTables - 欄 | 取得選取欄的欄索引。 | |
DataTables - 欄 | 取得選取欄的儲存格節點。 | |
DataTables - 欄 | 依選取欄排序表格。 | |
DataTables - 欄 | 取得有關選取欄的排序狀態的資訊。 | |
DataTables - 欄 | 取得欄集合的轉譯資料 | |
DataTables - 欄 | 在選取欄中搜尋資料。 | |
DataTables - 欄 | 取得/設定多個欄的標題。 | |
DataTables - 欄 | 取得選取欄的資料類型。 | |
DataTables - 欄 | 取得/設定選取欄的顯示狀態。 | |
DataTables - 欄 | 取得一組欄的寬度。 | |
DataTables - 欄 | 重新計算欄寬 | |
DataTables - 列 | 從表格中選取單一列。 | |
DataTables - 列 | 取得選取列的 DataTables 快取資料。 | |
DataTables - 列 | 列子方法命名空間 | |
DataTables - 列 | 取得/設定選取主表格列的子列 | |
DataTables - 列 | 在建立新的子列後隱藏子列 | |
DataTables - 列 | 銷毀選取父列的子列 | |
DataTables - 列 | 使新定義的子列可見 | |
DataTables - 列 | 隱藏父列的子列 | |
DataTables - 列 | 檢查父列的子列是否可見 | |
DataTables - 列 | 銷毀選取父列的子列 | |
DataTables - 列 | 使父列的子列可見 | |
DataTables - 列 | 取得/設定選取列的資料。 | |
DataTables - 列 | 取得選取列的 ID。 | |
DataTables - 列 | 取得選取列的列索引。 | |
DataTables - 列 | 使 DataTables 中保存的選取列資料失效 | |
DataTables - 列 | 取得選取列的 | |
DataTables - 列 | 從 DataTable 中刪除選取列。 | |
DataTables - 列 | 將新列新增至表格。 | |
DataTables - 列 | 從表格中選取多個列。 | |
DataTables - 列 | 取得選取列的 DataTables 快取資料。 | |
DataTables - 列 | 取得選取列的資料。 | |
DataTables - 列 | 反覆運算每個選取的列,並將函式內容設定為有問題的列。 | |
DataTables - 列 | 取得選取列的 ID。 | |
DataTables - 列 | 取得選取列的列索引。 | |
DataTables - 列 | 使 DataTables 中保存的選取列資料失效 | |
DataTables - 列 | 取得選取列的 | |
DataTables - 列 | 從 DataTable 中刪除選取列。 | |
DataTables - 列 | 將多個新列新增至表格。 | |
DataTables - 表格 | 取得/設定表格的標題 | |
DataTables - 表格 | 取得表格的 | |
DataTables - 表格 | 根據 API 上下文中的選取器選取表格 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得表格頁尾結構的 Javascript 表示 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得表格頁首結構的 Javascript 表示 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 根據 API 上下文中的選取器選取表格 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 表格 | 取得 API 上下文中表格的 | |
DataTables - 實用工具 | 判斷結果集中是否有任何項目 | |
DataTables - 實用工具 | 取得 API 實例中包含的元素數量 | |
DataTables - 實用工具 | 迭代處理 API 結果集的內容。 | |
DataTables - 實用工具 | 將 API 實例縮減為單一上下文和結果集。 | |
DataTables - 實用工具 | 觸發錯誤訊息。 | |
DataTables - 實用工具 | 建立一個新的 API 實例,其中包含結果集中通過給定測試的所有元素。 | |
DataTables - 實用工具 | 將 2D 陣列結構的 API 實例扁平化為 1D 陣列結構。 | |
DataTables - 實用工具 | 從 DataTable 實例取得基礎資料 | |
DataTables - 實用工具 | 判斷 API 結果集是否包含給定值。 | |
DataTables - 實用工具 | 在 API 實例的結果集中尋找值的第一次出現。 | |
DataTables - 實用工具 | 迭代處理表格、列、欄或儲存格索引的結果集 | |
DataTables - 實用工具 | 將結果集中的元素連接成字串。 | |
DataTables - 實用工具 | 在 API 實例的結果集中尋找值的最後一次出現。 | |
DataTables - 實用工具 | API 實例結果集中元素的數量。 | |
DataTables - 實用工具 | 建立一個新的 API 實例,其結果集由回呼函數傳回的值定義。 | |
DataTables - 實用工具 | 建立一個新的 API 實例,其中包含目前結果集中物件的屬性值。 | |
DataTables - 實用工具 | 從 API 實例的結果集中移除最後一個項目。 | |
DataTables - 實用工具 | 在 API 實例的結果集末尾新增一個或多個項目。 | |
DataTables - 實用工具 | 判斷 DataTable 是否已就緒。 | |
DataTables - 實用工具 | 針對累加器和 API 結果集中的每個元素(從左到右)套用回呼函數。 | |
DataTables - 實用工具 | 針對累加器和 API 結果集中的每個元素(從右到左)套用回呼函數。 | |
DataTables - 實用工具 | 反轉 API 實例的結果集。 | |
DataTables - 實用工具 | 從 API 實例的結果集中移除第一個項目。 | |
DataTables - 實用工具 | 建立 API 實例的獨立副本。 | |
DataTables - 實用工具 | 排序 API 實例結果集的元素。 | |
DataTables - 實用工具 | 修改 API 實例結果集的內容,根據需要新增或移除項目。 | |
DataTables - 實用工具 | 將 API 實例轉換為 jQuery 物件,其中包含 jQuery 結果集中實例的結果集物件。 | |
DataTables - 實用工具 | 從 API 實例建立原生 JavaScript 陣列物件。 | |
DataTables - 實用工具 | 將 API 實例轉換為 jQuery 物件,其中包含 jQuery 結果集中實例的結果集物件。 | |
DataTables - 實用工具 | 建立一個新的 API 實例,其中僅包含實例結果集中元素的唯一項目。 | |
DataTables - 實用工具 | 在 API 實例的結果集開頭新增一個或多個項目。 | |
DataTables - 靜態 | 註冊 DataTables 要使用的日期/時間格式 | |
DataTables - 靜態 | 建立一個可用於版面的新功能 | |
DataTables - 靜態 | 檢查表格節點是否為 DataTable | |
DataTables - 靜態 | 取得頁面上所有的 DataTables | |
DataTables - 靜態 | 取得/設定資料類型詳細資訊 | |
DataTables - 靜態 | 取得已註冊資料類型的清單 | |
DataTables - 靜態 | 取得/設定 DataTables 使用的程式庫或全域物件 | |
DataTables - 靜態 | 等待逾時後再呼叫函式 | |
DataTables - 靜態 | 正規化字串中的變音符號字元。 | |
DataTables - 靜態 | 逸出 HTML 實體,使使用者輸入字串安全 | |
DataTables - 靜態 | 逸出正規表示式字串中的特殊字元 | |
DataTables - 靜態 | 從描述器建立讀取函式 | |
DataTables - 靜態 | 從描述器建立寫入函式 | |
DataTables - 靜態 | 從字串中移除 HTML | |
DataTables - 靜態 | 限制方法呼叫次數以減少呼叫頻率 | |
DataTables - 靜態 | 從陣列中取得所有唯一項目 | |
DataTables - 靜態 | 版本號碼相容性檢查函式 | |
自動填入 | 停用自動填入的互動 | |
自動填入 | 啟用或停用自動填入的互動 | |
自動填入 | 判斷是否啟用或停用自動填入 | |
按鈕 | 儲存已在用戶端建立的檔案 | |
按鈕 | 選取單一按鈕 | |
按鈕 | 取得/設定所選按鈕的動作函式 | |
按鈕 | 取得/設定所選按鈕的活動狀態 | |
按鈕 | 建立新的按鈕並將其新增至文件 | |
按鈕 | 重建按鈕集合 | |
按鈕 | 停用所選按鈕 | |
按鈕 | 啟用/停用所選按鈕 | |
按鈕 | 取得節點的索引 | |
按鈕 | 取得所選按鈕的按鈕節點 | |
按鈕 | 顯示按鈕的彈出視窗,允許額外的使用者輸入 | |
按鈕 | 取得/設定按鈕的處理狀態 | |
按鈕 | 移除並刪除所選按鈕 | |
按鈕 | 取得/設定所選按鈕的文字 | |
按鈕 | 觸發所選按鈕的動作 | |
按鈕 | 選取一個或多個按鈕 | |
按鈕 | 取得/設定所選按鈕的動作函式 | |
按鈕 | 設定所選按鈕的活動狀態 | |
按鈕 | 重建按鈕集合 | |
按鈕 | 取得單一 Buttons 實例的容器元素 | |
按鈕 | 取得一個或多個按鈕實例的容器元素 | |
按鈕 | 銷毀一個或多個按鈕實例並從文件中移除 | |
按鈕 | 停用所選按鈕 | |
按鈕 | 啟用/停用所選按鈕 | |
按鈕 | 取得所選按鈕的按鈕節點 | |
按鈕 | 設定多個按鈕的處理狀態 | |
按鈕 | 移除並刪除所選按鈕 | |
按鈕 | 取得/設定所選按鈕的文字 | |
按鈕 | 觸發所選按鈕的動作 | |
按鈕 | 從 DataTable 取得適合匯出的資料 | |
按鈕 | 取得許多不同按鈕類型通用的匯出中繼資訊 | |
按鈕 | 在模式方塊中顯示和隱藏終端使用者的資訊 | |
欄位重新排序 | 停用欄位重新排序的互動 | |
欄位重新排序 | 啟用或停用欄位重新排序的互動 | |
欄位重新排序 | 以程式方式移動欄位 | |
欄位重新排序 | 取得/設定欄位順序 | |
欄位重新排序 | 還原已載入的欄位順序 | |
欄位重新排序 | 將一個或多個欄位索引轉換為目前和原始索引,反之亦然 | |
編輯器 | 使用內嵌或氣泡編輯編輯儲存格 | |
編輯器 | 使用氣泡編輯編輯儲存格 | |
編輯器 | 取得與此表格關聯的編輯器實例。 | |
編輯器 | 取得有關已上傳檔案的資訊 | |
編輯器 | 取得有關多個已上傳檔案的資訊 | |
編輯器 | 刪除現有列 | |
編輯器 | 編輯現有列 | |
編輯器 | 建立新列 | |
編輯器 | 刪除多個現有列 | |
編輯器 | 編輯多個現有列 | |
固定欄位 | 固定欄位方法的命名空間 | |
固定欄位 | 取得/設定表格結尾處固定的欄位數 | |
固定欄位 | 取得/設定表格左側固定的欄位數 | |
固定欄位 | 取得/設定表格右側固定的欄位數 | |
固定欄位 | 取得/設定表格開頭處固定的欄位數 | |
固定標頭 | 重新計算表格的位置並重繪固定元素 | |
固定標頭 | 停用固定元素 | |
固定標頭 | 啟用/停用固定元素 | |
固定標頭 | 取得目前的啟用狀態 | |
固定標頭 | 取得/設定固定頁尾的偏移量 | |
固定標頭 | 取得/設定固定標頭的偏移量 | |
KeyTable | 將焦點放在儲存格上 | |
KeyTable | 將焦點從表格模糊化 | |
KeyTable | 停用 KeyTable 的互動(滑鼠和鍵盤) | |
KeyTable | 啟用或停用 KeyTable 的互動(滑鼠和鍵盤) | |
KeyTable | 判斷表格的 KeyTable 啟用狀態 | |
KeyTable | 將焦點移至相鄰的儲存格 | |
響應式 | 取得表格中欄位的響應式可見性狀態 | |
響應式 | 取得表格中欄位的響應式可見狀態 | |
響應式 | 判斷響應式設計是否已隱藏表格中的任何欄位 | |
響應式 | 從 | |
響應式 | 根據欄位標題儲存格的類別資訊,重新計算欄位的中斷點 | |
響應式 | 在顯示變更後,重新計算響應式設計所使用的寬度 | |
RowGroup | 取得/設定列分組的資料來源 | |
RowGroup | 停用 RowGroup 與表格的互動 | |
RowGroup | 啟用或停用 RowGroup 與表格的互動 | |
RowGroup | 判斷是否在表格上啟用 RowGroup | |
RowReorder | 停用使用者重新排序列的功能。 | |
RowReorder | 啟用/停用使用者重新排序列的功能。 | |
Scroller | 捲動至特定列 | |
Scroller | 重新計算 Scroller 使用的快取測量值 | |
Scroller | 取得目前顯示的列的相關資訊 | |
Scroller | 捲動至特定的列顯示索引 | |
SearchBuilder | 傳回 SearchBuilder 容器的節點。 | |
SearchBuilder | 取得目前搜尋設定的詳細資訊 | |
SearchBuilder | 將搜尋重建為給定的狀態 | |
SearchPanes | 清除所有窗格中的選取項目 | |
SearchPanes | 傳回窗格容器的節點。 | |
SearchPanes | 重建窗格,從表格重新收集選項。 | |
SearchPanes | 調整所有窗格的大小,以適當地填滿 SearchPanes 容器。 | |
Select | 取消選取單一儲存格 | |
Select | 選取單一儲存格 | |
Select | 判斷儲存格是否已被選取 | |
Select | 取消選取儲存格 | |
Select | 選取儲存格 | |
Select | 取消選取單一欄位 | |
Select | 選取單一欄位 | |
Select | 判斷欄位是否已被選取 | |
Select | 取消選取欄位 | |
Select | 選取欄位 | |
Select | 取消選取單一列 | |
Select | 選取單一列 | |
Select | 判斷列是否已被選取 | |
Select | 取消選取列 | |
Select | 選取列 | |
Select | 從建構函式外部初始化 Select | |
Select | 取得/設定表格項目選取選項的模糊狀態 | |
Select | 取得/設定資訊摘要顯示狀態 | |
Select | 取得/設定 Select 將根據使用者互動選取的項目(列、欄位或儲存格) | |
Select | 取得/設定用於判斷列是否應該可選取的函式 | |
Select | 取得/設定用於滑鼠事件捕獲的項目選取器 | |
Select | 取得/設定最終使用者可以在表格中選取項目的樣式 | |
Select | 取得/設定當點擊已選取的項目時是否可以取消選取項目的行為 | |
StateRestore | 取得所有目前使用中狀態的詳細資訊 | |
StateRestore | 從 StateRestore 取得狀態 | |
StateRestore | 從 StateRestore 將狀態載入到表格中 | |
StateRestore | 從 StateRestore 移除狀態 | |
StateRestore | 從 StateRestore 重新命名狀態 | |
StateRestore | 從 StateRestore 儲存狀態 | |
StateRestore | 建立新的狀態 | |
StateRestore | 從 StateRestore 取得狀態 | |
StateRestore | 從 StateRestore 移除狀態 |