csv
创建一个 CSV 文件并将其保存包含表格中数据的文件。
请注意 - 该属性需要 DataTables 的 按钮 扩展。
说明
此类型的按钮是作为代理,该代理将自动检测是否可以使用 csvHtml5
根据浏览器的功能和可在页面中获取的库。
提供此选项是因为 HTML5 按钮类型需要较新的浏览器,可能并不总是对最终用户可用。
如果不满足 csvHtml5
按钮的需求,将不会向最终用户显示按钮。对于每个按钮类型的需求,请参阅其文档。
选项
除了对所有按钮都可用的选项(例如 buttons.buttons.text
)之外,此按钮可以在其配置对象中设置以下选项以自定义其动作和显示
名称 | 类型 | 默认 |
---|---|---|
操作 | ||
创建一个 CSV 文件并将其保存。 | ||
bom 自:1.2.2 | false | |
是否包含 UTF-8 字节顺序标记 ( | ||
字符集 | null | |
用于文件导出的字符集。当使用 | ||
类名 | buttons-csv buttons-html5 | |
按钮的类名。有关详细信息,请参阅 | ||
自定义 自:1.1.1 | undefined | |
可用于修改导出数据内容的功能。该函数接受两个参数,由按钮配置的数据和按钮的配置对象。该函数返回的值将用于导出。 如果你希望在导出的数据中添加公司页眉或页脚、说明数据或任何其他信息,此函数会特别有用。 自按钮 1.5.2 起,该函数传递三个参数
| ||
转义字符 | " | |
字符用作 CSV 数据的转义字符。它将加在任何数据字段中,该数据符合 | ||
exportOptions | {} | |
从 DataTable 中选择要导出的数据。这包括用于列、行、排序和搜索的选项。有关详细信息,请参阅 | ||
extension | .csv | |
赋予要创建的文件名的扩展名。 | ||
fieldBoundary | " | |
字符(多个)用于将复制到系统剪贴板的表格纯文本表示中的每个字段括起来。这将自动添加到每个单元格数据的开始和结束部分。 | ||
fieldSeparator | , | |
字符(多个)用于将复制到系统剪贴板的表格纯文本表示中的各个字段分隔开。 | ||
filename | * | |
赋予要创建的文件的文件名(再加上 | ||
footer | false | |
指示表脚是否应包含在导出的数据中。 | ||
header | true | |
指示表头是否应包含在导出的数据中。 | ||
newline | \n | |
字符(多个)用于分隔数据行。请注意,在 Windows 客户端上,默认值为 | ||
text | CSV | |
按钮的显示文本。可以使用此选项配置文本(请参阅 |
实例
DataTables 初始化:使用 HTML5 CSV 按钮
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['csv']
}
}
});
DataTables 初始化:无论如何筛选,使用 exportOptions
保存全部数据
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'csv',
text: 'Copy all data',
exportOptions: {
modifier: {
search: 'none'
}
}
}
]
}
}
});