{hero}

caption()

自 DataTables 2.0 起:

取得 / 設定表格的標題。

描述

HTML 表格有一個可選的元素,稱為 caption,可用於向最終使用者顯示表格的標題。這可以大大提高可訪問性,因為它可以提供表格內容的摘要,而無需最終使用者閱讀周圍的文字。

此方法提供了控制 DataTables 的 caption 元素內容的功能。

類型

function caption()

描述

取得表格 caption 元素的內容。

請注意,如果 API 實例引用多個表格,則只會考慮集合中的第一個表格進行 getter 操作。

回傳值

標題元素的內容。如果沒有標題,則為 null

function caption( set [, side ] )

描述

設定 caption 元素的內容。如果表格沒有 caption 元素,則會自動建立一個。

請注意,如果 API 實例引用多個表格,則會為所有引用的表格設定標題。

參數
回傳值

用於鏈接的 DataTables API 實例。

範例

設定表格的標題

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

table.caption('Table 1: Class averages');

設定表格的標題並顯示在表格底部

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

table.caption('Table 2: Year averages', 'bottom');

相關

以下選項直接相關,可能在您的應用程式開發中也很有用。