excel
创建并保存一个包含表格数据 Excel CSV 文件。
请注意 - 这个属性需要 DataTables 的 按钮 扩展。
说明
此按钮类型作为代理服务器自动检测,基于浏览器的功能和页面上可用的库,excelHtml5
按钮是否可用。
提供此选项是因为 HTML5 按钮类型需要相当现代的浏览器,而该浏览器可能并不总是对最终用户可用。
如果 excelHtml5
按钮的需求未得到满足,则不会向最终用户显示任何按钮。对于每种按钮类型,请参阅其自有文档。
样式和定制
有关如何自定义创建的 XLSX 文件,请参阅 excelHtml5
按钮中定制部分的文档。
选项
除了可用于所有按钮的选项(如 buttons.buttons.text
),此按钮还可以在其配置对象中设置以下选项,以便定制其操作和显示
名称 | 类型 | 默认值 |
---|---|---|
action | ||
创建和保存一个 Excel 文件。 | ||
className | buttons-excel | |
按钮的类名。详情请见 | ||
createEmptyCells 自:1.5.0 | false | |
指示 Excel 导出创建空单元格的选项。默认情况下,如果单元格包含 | ||
customize 自:1.2.0 | undefined | |
此方法可以用于修改 Buttons 创建的 XSLX 文件。传入的第一个参数是一个对象,其中包含 XML 文件,该对象的结构与 XSLX 文件中这些文件的路径相匹配。XSLX 文件的定制是一个复杂的话题 - 有关全部细节,请参阅 自 Buttons 1.5.2 起,此函数传入三个参数
| ||
exportOptions | {} | |
选择要从 DataTable 收集用于导出的数据。这包括哪些列、行、排序和搜索的选项。有关详细信息,请参见 | ||
extension | .xlsx | |
要给创建的文件取的扩展名。 | ||
filename | * | |
给创建的文件指定的文件名(加上 | ||
footer | false | |
指示是否在导出的数据中包括表脚注。 | ||
header | true | |
指示是否在导出的数据中包括表头。 | ||
messageBottom 自 1.4.0 起 | * | |
显示在表底部或 | ||
messageTop 自 1.4.0 起 | * | |
显示在表顶部或 | ||
sheetName | Sheet1 | |
创建的 Excel 文件中工作表的名称。不允许使用字符 [] \ /: *? :,如果存在则会将其删除。 | ||
text | Excel | |
按钮显示的文本。可以使用这个选项(见 | ||
title 自 1.4.0 起 | * | |
将包含在导出数据中的表的标题。有关此参数的所有选项,请参见 |
示例
DataTables 初始化:使用 excel
按钮类型自动将 HTML 按钮选项定义为别名。
new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['excel']
}
}
});
DataTables 初始化:使用 exportOptions
仅保存当前 DataTable 页面上显示的数据
new DataTable('#myTable', {
layout: {
topStart: {
buttons: [
{
extend: 'excel',
text: 'Save current page',
exportOptions: {
modifier: {
page: 'current'
}
}
}
]
}
}
});