csvHtml5
创建并保存一个 CSV 文件,其中包含表格数据(HTML5)。
请注意 - 此属性需要 DataTables 的 Buttons 扩展。
说明
此按钮使用户能够将表格数据保存到本地创建的 逗号分隔值 (CSV) 文件中。此文件可供各种程序使用,包括电子表格和数据分析应用程序。
如果表格具有包含多行的页眉或页脚,则所有这些都将包含在导出中。如果页眉或页脚包含 colspan
或 rowspan
单元格,它们将被空字符串填充,因为 CSV 是一个纯文本文件,并且没有办法表示跨越其他单元格的单元格。
选项
除了可用于所有按钮的选项(例如 buttons.buttons.text
),此按钮还可以在其配置对象中设置以下选项以自定义其操作和显示
名称 | 类型 | 默认值 |
---|---|---|
action | ||
创建并保存一个 CSV 文件。 | ||
bom 自:1.2.2 起 | false | |
选项可包含 UTF-8 字节顺序标记( | ||
charset | null | |
用于文件导出的字符集。当使用 | ||
className | buttons-csv buttons-html5 | |
按钮的类名。有关详细信息,请参见 | ||
customize 自:1.1.1 起 | undefined | |
可用于修改已导出数据内容的函数。该函数接收两个参数,一个是由按钮配置的数据以及按钮的配置对象。该函数返回的值将用于导出。 如果您希望在已导出数据中添加公司页眉或页脚、描述数据或任何其他信息,这可能特别有用。 自 Buttons 1.5.2 起,该函数会传递三个参数
| ||
escapeChar | " | |
用作 CSV 数据转义字符的字符。它将被前缀添加到字段中找到的任何数据中,该数据与 | ||
exportOptions | {} | |
选择要从 DataTable 中提取以供导出的数据。其中包括列、行、排序和搜索的选项。有关完整详细信息,请参阅 | ||
扩展 | .csv | |
创建的文件名称的扩展名。 | ||
字段边界 | " | |
用来将以 CSV 文件中保存的表格的纯文本表示形式中的每个字段包含起来的字符(或字符)。这会自动添加到每个单元格数据的开始和结束处。 | ||
字段分隔符 | , | |
用来分隔以 CSV 文件中保存的表格的纯文本表示形式中的字段的字符(或字符)。 | ||
文件名 | * | |
要给创建的文件的文件名称(加上由 | ||
页脚 | true | |
指示是否应将表格页脚包括在导出数据中。请注意,此参数的默认值在 Buttons 3.0 中已更新为 | ||
页眉 | true | |
指示是否应将表格页眉包括在导出数据中。 | ||
换行符 | \n | |
用来分隔数据行的字符(或字符)。请注意,在 Windows 客户端中,默认值为 | ||
文本 | CSV | |
按钮的显示文本。可以使用此选线配置文本(请参见 |
示例
DataTables 初始化:使用 HTML5 CSV 按钮
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['csvHtml5']
}
}
});
DataTables 初始化:使用 csv
按钮类型来设置 HTML 按钮选项的别名。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['csv']
}
}
});
DataTables 初始化:使用 exportOptions
在不考虑过滤的情况下保存所有数据
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'csvHtml5',
text: 'Copy all data',
exportOptions: {
modifier: {
search: 'none'
}
}
}
]
}
}
});