复制
将表格数据复制到剪贴板按钮。
请注意 - 该属性需要 DataTables 的 Buttons 扩展。
描述
该按钮类型用作代理,会根据浏览器的功能和页面中的可用库自动检测是否可以使用 copyHtml5
按钮。
由于 HTML5 中没有 API 允许在单击按钮时复制到剪贴板操作,因此提供了该功能。
如果未满足 copyHtml5
按钮的要求,则将不会向最终用户显示任何按钮。有关每种按钮类型的要求,请参阅其自己的文档。
选项
除了所有按钮可用的选项(如 buttons.buttons.text
)外,该按钮在其配置对象中可以设置以下选项,来自定义其操作和显示:
名称 | 类型 | 默认 |
---|---|---|
action | ||
显示用户可用于将表格数据复制到剪贴板的对话框 | ||
className | buttons-copy | |
按钮的类名。有关详细信息,请参见 | ||
copySuccess 自:3.1.2 起 | true | |
指示在完成复制时是否应显示该消息。 | ||
customize 自:1.1.1 起 | undefined | |
可用于修改导出数据内容的函数。该函数采用两个参数:按钮配置的数据和按钮的配置对象。函数返回的值将用于导出。 如果您希望向导出的数据添加公司页眉或页脚、说明数据或任何其他信息,此函数会特别有用。 自 Buttons 1.5.2 起,此函数将传递三个参数
| ||
exportOptions | {} | |
选择从 DataTable 中收集的要导出的数据。这包括哪些列、行、排序和搜索的选项。有关完整详细信息,请参见 | ||
fieldBoundary | ||
字符(用于将表格纯文本表示中的每个字段括起来,该字段已复制到系统的剪贴板。它会自动添加到每个单元格数据的开头和结尾。 | ||
fieldSeparator | \t | |
字符(用于分隔表格纯文本表示中的字段,该字段已复制到系统的剪贴板。 | ||
footer | false | |
指示是否将表格页脚包含在已导出的数据中。 | ||
页眉 | true | |
指示是否将表格页眉包含在已导出的数据中。 | ||
底部消息 自:1.4.0 | * | |
将显示在表格底部的消息,或显示在表格底部的 | ||
顶部消息 自:1.4.0 | * | |
将显示在表格顶部的消息,或显示在表格顶部的 | ||
新行 | \n | |
用于分隔数据行的字符。请注意,在 Windows 客户端中,默认值为 | ||
文本 | 复制 | |
按钮的显示文本。可以使用此选项配置文本(参见 | ||
标题 自:1.4.0 | * | |
将包含在已导出数据中的表格标题。请参见 |
示例
DataTables 初始化:使用 copy
按钮类型来设置 HTML 按钮选项的别名。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['copy']
}
}
});
DataTables 初始化:使用 exportOptions
仅复制当前 DataTable 页面。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'copy',
text: 'Copy current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});