()
自:DataTables 2.0 起
获取/设置表格的标题。
描述
HTML 表格具有的一个 可选项被称为 caption
,它可以用来向终端用户显示表格的标题。这可以大大增强可访问性,因为它可以在不需终端用户阅读周边文本的情况下总结表格的内容。
此方法用来控制 DataTables 的 caption
元素的内容。
类型
函数 caption()
- 描述
获取表格的
caption
元素的内容。请注意,如果 API 实例引用多个表格,则只考虑集合中的第一个表格作为获取者。
- 返回值
标题元素的内容。如果无标题,该值为
null
。
函数 caption( set [, side ] )
- 描述
设置
caption
元素的内容。如果表格没有caption
元素,将自动创建一个。请注意,如果 API 实例引用多个表格,将为所有引用的表格设置标题。
- 参数
名称 类型 可选 1 set
否 表格的
caption
中要显示的值。2 side
是 通常,
caption
元素的位置由表格的caption-side
CSS 属性 定义,但此选项允许直接设置该选项。可传入
top
或bottom
。如果完全不传入,标题相对于表格的位置将由页面的 CSS 定义。在浏览器中,默认在表格上方。- 返回值
用于链接的 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');
相关
以下选项直接相关,在您的应用程序开发中可能也实用。