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

Ajax 方法的命名空間

DataTables - 核心

ajax.json()

取得 DataTables 在上次 Ajax 請求中獲得的最新 JSON 資料

DataTables - 核心

ajax.params()

取得 DataTables 在上次 Ajax 請求中提交至伺服器的資料

DataTables - 核心

ajax.reload()

從 Ajax 資料來源重新載入表格資料

DataTables - 核心

ajax.url()

取得/設定 DataTables 用於 Ajax 擷取資料的 URL

DataTables - 核心

ajax.url().load()

從新設定的資料來源 URL 載入資料

DataTables - 核心

clear()

清除表格中的所有資料。

DataTables - 核心

column().init()

取得欄的初始化選項。

DataTables - 核心

column().search.fixed()

取得/設定要套用至欄的具名搜尋。

DataTables - 核心

columns().init()

取得選定欄的初始化選項。

DataTables - 核心

columns().search.fixed()

取得/設定要套用至欄的具名搜尋。

DataTables - 核心

data()

取得整個表格的資料。

DataTables - 核心

destroy()

銷毀目前上下文中的 DataTables。

DataTables - 核心

draw()

重新繪製表格。

DataTables - 核心

i18n()

國際化權杖查閱。

DataTables - 核心

init()

取得表格使用的初始化選項。

DataTables - 核心

off()

表格事件移除。

DataTables - 核心

on()

表格事件監聽器。

DataTables - 核心

one()

監聽一次表格事件,然後移除監聽器。

DataTables - 核心

order()

取得/設定套用至表格的排序。

DataTables - 核心

order.fixed()

取得/設定套用至表格的固定排序。

DataTables - 核心

order.listener()

將排序監聽器新增至元素,用於指定的欄。

DataTables - 核心

page()

取得/設定表格的目前頁面。

DataTables - 核心

page.info()

取得表格的分頁資訊

DataTables - 核心

page.len()

取得/設定表格的頁面長度。

DataTables - 核心

processing()

設定 DataTable 的處理指示器狀態。

DataTables - 核心

search()

在表格中搜尋資料。

DataTables - 核心

search.fixed()

取得/設定要套用至表格的具名搜尋。

DataTables - 核心

settings()

取得表格的設定物件

DataTables - 核心

state()

取得/設定表格的狀態

DataTables - 核心

state.clear()

清除表格的已儲存狀態。

DataTables - 核心

state.loaded()

取得初始化期間載入的表格狀態。

DataTables - 核心

state.save()

觸發狀態儲存。

DataTables - 核心

trigger()

觸發事件。

DataTables - 儲存格

cell()

從表格中選取單一儲存格。

DataTables - 儲存格

cell().cache()

取得選取儲存格的 DataTables 快取資料

DataTables - 儲存格

cell().data()

取得/設定選取儲存格的資料

DataTables - 儲存格

cell().index()

取得選取儲存格的索引資訊

DataTables - 儲存格

cell().invalidate()

使 DataTables 中保存的選取儲存格資料失效

DataTables - 儲存格

cell().node()

取得選取儲存格的 DOM 元素

DataTables - 儲存格

cell().render()

取得儲存格的轉譯資料

DataTables - 儲存格

cells()

從表格中選取多個儲存格。

DataTables - 儲存格

cells().cache()

取得選取儲存格的 DataTables 快取資料

DataTables - 儲存格

cells().data()

取得選取儲存格的資料

DataTables - 儲存格

cells().every()

反覆運算每個選取的儲存格,並將函式內容設定為有問題的儲存格。

DataTables - 儲存格

cells().indexes()

取得選取儲存格的索引資訊

DataTables - 儲存格

cells().invalidate()

使 DataTables 中保存的選取儲存格資料失效

DataTables - 儲存格

cells().nodes()

取得選取儲存格的 DOM 元素

DataTables - 儲存格

cells().render()

取得儲存格集合的轉譯資料

DataTables - 欄

column()

從表格中選取單一欄。

DataTables - 欄

column().cache()

取得選取欄的 DataTables 快取資料。

DataTables - 欄

column().data()

取得選取欄中儲存格的資料。

DataTables - 欄

column().dataSrc()

取得選取欄的資料來源屬性。

DataTables - 欄

column().footer()

取得選取欄的頁尾節點。

DataTables - 欄

column().header()

取得選取欄的頁首節點。

DataTables - 欄

column().index()

取得選取欄的欄索引。

DataTables - 欄

column().nodes()

取得選取欄的儲存格節點。

DataTables - 欄

column().order()

依選取欄排序表格。

DataTables - 欄

column().orderable()

取得有關欄的排序狀態的資訊。

DataTables - 欄

column().render()

取得欄的轉譯資料

DataTables - 欄

column().search()

在選取欄中搜尋資料。

DataTables - 欄

column().title()

取得/設定欄的標題。

DataTables - 欄

column().type()

取得欄的資料類型。

DataTables - 欄

column().visible()

取得/設定單一選取欄的顯示狀態。

DataTables - 欄

column().width()

取得欄的寬度。

DataTables - 欄

column.index()

在欄索引格式之間轉換

DataTables - 欄

columns()

從表格中選取多個欄。

DataTables - 欄

columns().cache()

取得選取欄的 DataTables 快取資料。

DataTables - 欄

columns().data()

取得選取欄中儲存格的資料。

DataTables - 欄

columns().dataSrc()

取得選取欄的資料來源屬性。

DataTables - 欄

columns().every()

反覆運算每個選取的欄,並將函式內容設定為有問題的欄。

DataTables - 欄

columns().footer()

取得選取欄的頁尾節點。

DataTables - 欄

columns().header()

取得選取欄的頁首節點。

DataTables - 欄

columns().indexes()

取得選取欄的欄索引。

DataTables - 欄

columns().nodes()

取得選取欄的儲存格節點。

DataTables - 欄

columns().order()

依選取欄排序表格。

DataTables - 欄

columns().orderable()

取得有關選取欄的排序狀態的資訊。

DataTables - 欄

columns().render()

取得欄集合的轉譯資料

DataTables - 欄

columns().search()

在選取欄中搜尋資料。

DataTables - 欄

columns().titles()

取得/設定多個欄的標題。

DataTables - 欄

columns().types()

取得選取欄的資料類型。

DataTables - 欄

columns().visible()

取得/設定選取欄的顯示狀態。

DataTables - 欄

columns().widths()

取得一組欄的寬度。

DataTables - 欄

columns.adjust()

重新計算欄寬

DataTables - 列

row()

從表格中選取單一列。

DataTables - 列

row().cache()

取得選取列的 DataTables 快取資料。

DataTables - 列

row().child

列子方法命名空間

DataTables - 列

row().child()

取得/設定選取主表格列的子列

DataTables - 列

row().child().hide()

在建立新的子列後隱藏子列

DataTables - 列

row().child().remove()

銷毀選取父列的子列

DataTables - 列

row().child().show()

使新定義的子列可見

DataTables - 列

row().child.hide()

隱藏父列的子列

DataTables - 列

row().child.isShown()

檢查父列的子列是否可見

DataTables - 列

row().child.remove()

銷毀選取父列的子列

DataTables - 列

row().child.show()

使父列的子列可見

DataTables - 列

row().data()

取得/設定選取列的資料。

DataTables - 列

row().id()

取得選取列的 ID。

DataTables - 列

row().index()

取得選取列的列索引。

DataTables - 列

row().invalidate()

使 DataTables 中保存的選取列資料失效

DataTables - 列

row().node()

取得選取列的 TR 節點。

DataTables - 列

row().remove()

從 DataTable 中刪除選取列。

DataTables - 列

row.add()

將新列新增至表格。

DataTables - 列

rows()

從表格中選取多個列。

DataTables - 列

rows().cache()

取得選取列的 DataTables 快取資料。

DataTables - 列

rows().data()

取得選取列的資料。

DataTables - 列

rows().every()

反覆運算每個選取的列,並將函式內容設定為有問題的列。

DataTables - 列

rows().ids()

取得選取列的 ID。

DataTables - 列

rows().indexes()

取得選取列的列索引。

DataTables - 列

rows().invalidate()

使 DataTables 中保存的選取列資料失效

DataTables - 列

rows().nodes()

取得選取列的 TR 節點。

DataTables - 列

rows().remove()

從 DataTable 中刪除選取列。

DataTables - 列

rows.add()

將多個新列新增至表格。

DataTables - 表格

caption()

取得/設定表格的標題

DataTables - 表格

caption.node()

取得表格的 caption 元素

DataTables - 表格

table()

根據 API 上下文中的選取器選取表格

DataTables - 表格

table().body()

取得 API 上下文中表格的 tbody 節點

DataTables - 表格

table().container()

取得 API 上下文中表格的 div 容器節點

DataTables - 表格

table().footer()

取得 API 上下文中表格的 tfoot 節點

DataTables - 表格

table().footer.structure()

取得表格頁尾結構的 Javascript 表示

DataTables - 表格

table().header()

取得 API 上下文中表格的 thead 節點

DataTables - 表格

table().header.structure()

取得表格頁首結構的 Javascript 表示

DataTables - 表格

table().node()

取得 API 上下文中表格的 table 節點

DataTables - 表格

tables()

根據 API 上下文中的選取器選取表格

DataTables - 表格

tables().body()

取得 API 上下文中表格的 tbody 節點

DataTables - 表格

tables().containers()

取得 API 上下文中表格的 div 容器節點

DataTables - 表格

tables().footer()

取得 API 上下文中表格的 tfoot 節點

DataTables - 表格

tables().header()

取得 API 上下文中表格的 thead 節點

DataTables - 表格

tables().nodes()

取得 API 上下文中表格的 table 節點

DataTables - 實用工具

any()

判斷結果集中是否有任何項目

DataTables - 實用工具

count()

取得 API 實例中包含的元素數量

DataTables - 實用工具

each()

迭代處理 API 結果集的內容。

DataTables - 實用工具

eq()

將 API 實例縮減為單一上下文和結果集。

DataTables - 實用工具

error()

觸發錯誤訊息。

DataTables - 實用工具

filter()

建立一個新的 API 實例,其中包含結果集中通過給定測試的所有元素。

DataTables - 實用工具

flatten()

將 2D 陣列結構的 API 實例扁平化為 1D 陣列結構。

DataTables - 實用工具

get()

從 DataTable 實例取得基礎資料

DataTables - 實用工具

includes()

判斷 API 結果集是否包含給定值。

DataTables - 實用工具

indexOf()

在 API 實例的結果集中尋找值的第一次出現。

DataTables - 實用工具

iterator()

迭代處理表格、列、欄或儲存格索引的結果集

DataTables - 實用工具

join()

將結果集中的元素連接成字串。

DataTables - 實用工具

lastIndexOf()

在 API 實例的結果集中尋找值的最後一次出現。

DataTables - 實用工具

length

API 實例結果集中元素的數量。

DataTables - 實用工具

map()

建立一個新的 API 實例,其結果集由回呼函數傳回的值定義。

DataTables - 實用工具

pluck()

建立一個新的 API 實例,其中包含目前結果集中物件的屬性值。

DataTables - 實用工具

pop()

從 API 實例的結果集中移除最後一個項目。

DataTables - 實用工具

push()

在 API 實例的結果集末尾新增一個或多個項目。

DataTables - 實用工具

ready()

判斷 DataTable 是否已就緒。

DataTables - 實用工具

reduce()

針對累加器和 API 結果集中的每個元素(從左到右)套用回呼函數。

DataTables - 實用工具

reduceRight()

針對累加器和 API 結果集中的每個元素(從右到左)套用回呼函數。

DataTables - 實用工具

reverse()

反轉 API 實例的結果集。

DataTables - 實用工具

shift()

從 API 實例的結果集中移除第一個項目。

DataTables - 實用工具

slice()

建立 API 實例的獨立副本。

DataTables - 實用工具

sort()

排序 API 實例結果集的元素。

DataTables - 實用工具

splice()

修改 API 實例結果集的內容,根據需要新增或移除項目。

DataTables - 實用工具

to$()

將 API 實例轉換為 jQuery 物件,其中包含 jQuery 結果集中實例的結果集物件。

DataTables - 實用工具

toArray()

從 API 實例建立原生 JavaScript 陣列物件。

DataTables - 實用工具

toJQuery()

將 API 實例轉換為 jQuery 物件,其中包含 jQuery 結果集中實例的結果集物件。

DataTables - 實用工具

unique()

建立一個新的 API 實例,其中僅包含實例結果集中元素的唯一項目。

DataTables - 實用工具

unshift()

在 API 實例的結果集開頭新增一個或多個項目。

DataTables - 靜態

DataTable.datetime()

註冊 DataTables 要使用的日期/時間格式

DataTables - 靜態

DataTable.feature.register()

建立一個可用於版面的新功能

DataTables - 靜態

DataTable.isDataTable()

檢查表格節點是否為 DataTable

DataTables - 靜態

DataTable.tables()

取得頁面上所有的 DataTables

DataTables - 靜態

DataTable.type()

取得/設定資料類型詳細資訊

DataTables - 靜態

DataTable.types()

取得已註冊資料類型的清單

DataTables - 靜態

DataTable.use()

取得/設定 DataTables 使用的程式庫或全域物件

DataTables - 靜態

DataTable.util.debounce()

等待逾時後再呼叫函式

DataTables - 靜態

DataTable.util.diacritics()

正規化字串中的變音符號字元。

DataTables - 靜態

DataTable.util.escapeHtml()

逸出 HTML 實體,使使用者輸入字串安全

DataTables - 靜態

DataTable.util.escapeRegex()

逸出正規表示式字串中的特殊字元

DataTables - 靜態

DataTable.util.get()

從描述器建立讀取函式

DataTables - 靜態

DataTable.util.set()

從描述器建立寫入函式

DataTables - 靜態

DataTable.util.stripHtml()

從字串中移除 HTML

DataTables - 靜態

DataTable.util.throttle()

限制方法呼叫次數以減少呼叫頻率

DataTables - 靜態

DataTable.util.unique()

從陣列中取得所有唯一項目

DataTables - 靜態

DataTable.versionCheck()

版本號碼相容性檢查函式

自動填入

autoFill().disable()

停用自動填入的互動

自動填入

autoFill().enable()

啟用或停用自動填入的互動

自動填入

autoFill().enabled()

判斷是否啟用或停用自動填入

按鈕

DataTable.fileSave()

儲存已在用戶端建立的檔案

按鈕

button()

選取單一按鈕

按鈕

button().action()

取得/設定所選按鈕的動作函式

按鈕

button().active()

取得/設定所選按鈕的活動狀態

按鈕

button().add()

建立新的按鈕並將其新增至文件

按鈕

button().collectionRebuild()

重建按鈕集合

按鈕

button().disable()

停用所選按鈕

按鈕

button().enable()

啟用/停用所選按鈕

按鈕

button().index()

取得節點的索引

按鈕

button().node()

取得所選按鈕的按鈕節點

按鈕

button().popover()

顯示按鈕的彈出視窗,允許額外的使用者輸入

按鈕

button().processing()

取得/設定按鈕的處理狀態

按鈕

button().remove()

移除並刪除所選按鈕

按鈕

button().text()

取得/設定所選按鈕的文字

按鈕

button().trigger()

觸發所選按鈕的動作

按鈕

buttons()

選取一個或多個按鈕

按鈕

buttons().action()

取得/設定所選按鈕的動作函式

按鈕

buttons().active()

設定所選按鈕的活動狀態

按鈕

buttons().collectionRebuild()

重建按鈕集合

按鈕

buttons().container()

取得單一 Buttons 實例的容器元素

按鈕

buttons().containers()

取得一個或多個按鈕實例的容器元素

按鈕

buttons().destroy()

銷毀一個或多個按鈕實例並從文件中移除

按鈕

buttons().disable()

停用所選按鈕

按鈕

buttons().enable()

啟用/停用所選按鈕

按鈕

buttons().nodes()

取得所選按鈕的按鈕節點

按鈕

buttons().processing()

設定多個按鈕的處理狀態

按鈕

buttons().remove()

移除並刪除所選按鈕

按鈕

buttons().text()

取得/設定所選按鈕的文字

按鈕

buttons().trigger()

觸發所選按鈕的動作

按鈕

buttons.exportData()

從 DataTable 取得適合匯出的資料

按鈕

buttons.exportInfo()

取得許多不同按鈕類型通用的匯出中繼資訊

按鈕

buttons.info()

在模式方塊中顯示和隱藏終端使用者的資訊

欄位重新排序

colReorder.disable()

停用欄位重新排序的互動

欄位重新排序

colReorder.enable()

啟用或停用欄位重新排序的互動

欄位重新排序

colReorder.move()

以程式方式移動欄位

欄位重新排序

colReorder.order()

取得/設定欄位順序

欄位重新排序

colReorder.reset()

還原已載入的欄位順序

欄位重新排序

colReorder.transpose()

將一個或多個欄位索引轉換為目前和原始索引,反之亦然

編輯器

cell().edit()

使用內嵌或氣泡編輯編輯儲存格

編輯器

cells().edit()

使用氣泡編輯編輯儲存格

編輯器

editor()

取得與此表格關聯的編輯器實例。

編輯器

file()

取得有關已上傳檔案的資訊

編輯器

files()

取得有關多個已上傳檔案的資訊

編輯器

row().delete()

刪除現有列

編輯器

row().edit()

編輯現有列

編輯器

row.create()

建立新列

編輯器

rows().delete()

刪除多個現有列

編輯器

rows().edit()

編輯多個現有列

固定欄位

fixedColumns()

固定欄位方法的命名空間

固定欄位

fixedColumns().end()

取得/設定表格結尾處固定的欄位數

固定欄位

fixedColumns().left()

取得/設定表格左側固定的欄位數

固定欄位

fixedColumns().right()

取得/設定表格右側固定的欄位數

固定欄位

fixedColumns().start()

取得/設定表格開頭處固定的欄位數

固定標頭

fixedHeader.adjust()

重新計算表格的位置並重繪固定元素

固定標頭

fixedHeader.disable()

停用固定元素

固定標頭

fixedHeader.enable()

啟用/停用固定元素

固定標頭

fixedHeader.enabled()

取得目前的啟用狀態

固定標頭

fixedHeader.footerOffset()

取得/設定固定頁尾的偏移量

固定標頭

fixedHeader.headerOffset()

取得/設定固定標頭的偏移量

KeyTable

cell().focus()

將焦點放在儲存格上

KeyTable

cell.blur()

將焦點從表格模糊化

KeyTable

keys.disable()

停用 KeyTable 的互動(滑鼠和鍵盤)

KeyTable

keys.enable()

啟用或停用 KeyTable 的互動(滑鼠和鍵盤)

KeyTable

keys.enabled()

判斷表格的 KeyTable 啟用狀態

KeyTable

keys.move()

將焦點移至相鄰的儲存格

響應式

column().responsiveHidden()

取得表格中欄位的響應式可見性狀態

響應式

columns().responsiveHidden()

取得表格中欄位的響應式可見狀態

響應式

responsive.hasHidden()

判斷響應式設計是否已隱藏表格中的任何欄位

響應式

responsive.index()

li 詳細資訊元素取得儲存格索引

響應式

responsive.rebuild()

根據欄位標題儲存格的類別資訊,重新計算欄位的中斷點

響應式

responsive.recalc()

在顯示變更後,重新計算響應式設計所使用的寬度

RowGroup

rowGroup().dataSrc()

取得/設定列分組的資料來源

RowGroup

rowGroup().disable()

停用 RowGroup 與表格的互動

RowGroup

rowGroup().enable()

啟用或停用 RowGroup 與表格的互動

RowGroup

rowGroup().enabled()

判斷是否在表格上啟用 RowGroup

RowReorder

rowReorder.disable()

停用使用者重新排序列的功能。

RowReorder

rowReorder.enable()

啟用/停用使用者重新排序列的功能。

Scroller

row().scrollTo()

捲動至特定列

Scroller

scroller.measure()

重新計算 Scroller 使用的快取測量值

Scroller

scroller.page()

取得目前顯示的列的相關資訊

Scroller

scroller.toPosition()

捲動至特定的列顯示索引

SearchBuilder

searchBuilder.container()

傳回 SearchBuilder 容器的節點。

SearchBuilder

searchBuilder.getDetails()

取得目前搜尋設定的詳細資訊

SearchBuilder

searchBuilder.rebuild()

將搜尋重建為給定的狀態

SearchPanes

searchPanes.clearSelections()

清除所有窗格中的選取項目

SearchPanes

searchPanes.container()

傳回窗格容器的節點。

SearchPanes

searchPanes.rebuildPane()

重建窗格,從表格重新收集選項。

SearchPanes

searchPanes.resizePanes()

調整所有窗格的大小,以適當地填滿 SearchPanes 容器。

Select

cell().deselect()

取消選取單一儲存格

Select

cell().select()

選取單一儲存格

Select

cell().selected()

判斷儲存格是否已被選取

Select

cells().deselect()

取消選取儲存格

Select

cells().select()

選取儲存格

Select

column().deselect()

取消選取單一欄位

Select

column().select()

選取單一欄位

Select

column().selected()

判斷欄位是否已被選取

Select

columns().deselect()

取消選取欄位

Select

columns().select()

選取欄位

Select

row().deselect()

取消選取單一列

Select

row().select()

選取單一列

Select

row().selected()

判斷列是否已被選取

Select

rows().deselect()

取消選取列

Select

rows().select()

選取列

Select

select()

從建構函式外部初始化 Select

Select

select.blurable()

取得/設定表格項目選取選項的模糊狀態

Select

select.info()

取得/設定資訊摘要顯示狀態

Select

select.items()

取得/設定 Select 將根據使用者互動選取的項目(列、欄位或儲存格)

Select

select.selectable()

取得/設定用於判斷列是否應該可選取的函式

Select

select.selector()

取得/設定用於滑鼠事件捕獲的項目選取器

Select

select.style()

取得/設定最終使用者可以在表格中選取項目的樣式

Select

select.toggleable()

取得/設定當點擊已選取的項目時是否可以取消選取項目的行為

StateRestore

stateRestore.activeStates()

取得所有目前使用中狀態的詳細資訊

StateRestore

stateRestore.state()

從 StateRestore 取得狀態

StateRestore

stateRestore.state().load()

從 StateRestore 將狀態載入到表格中

StateRestore

stateRestore.state().remove()

從 StateRestore 移除狀態

StateRestore

stateRestore.state().rename()

從 StateRestore 重新命名狀態

StateRestore

stateRestore.state().save()

從 StateRestore 儲存狀態

StateRestore

stateRestore.state.add()

建立新的狀態

StateRestore

stateRestore.states()

從 StateRestore 取得狀態

StateRestore

stateRestore.states().remove()

從 StateRestore 移除狀態