pdf

自：Buttons 1.0.0

创建并保存一个包含表格数据的 PDF 文件。
请注意 - 此属性需要 DataTables 的Buttons扩展。

说明

此按钮类型作为代理使用，它将自动检测基于浏览器的功能和页面中现有的库，pdfHtml5按钮是否可以使用。

这是作为选择提供的，因为 HTML5 按钮类型需要相当现代的浏览器，但最终用户并不总能使用它。

如果 pdfHtml5 按钮的需求无法满足，则没有按钮会呈现给最终用户。有关每个按钮类型的要求，请参阅其自身的文档。

选项

除了可以用于所有按钮的其他选项（例如 buttons.buttons.text）之外，此按钮可以在其配置对象中设置以下选项，以自定义其操作和显示。

名称	类型	默认
`action`
创建并保存一个 PDF 文件。
`className`		buttons-pdf
按钮的类名称。参见 `buttons.buttons.className` 了解详细信息。
`customize`		null
一个函数，可用于自定义 `pdfHtml5` 按钮的 PDFMake 文档定义对象。此函数会将文档对象作为第一个参数传入，应根据需要进行操作。它不希望或不使用返回值。请参阅PDFMake 文档，了解如何操作此对象以及为生成的 PDF 提供的选项的信息。从 Buttons 1.5.2 开始，此函数会传入三个参数包含 PDFMake 文档结构的对象。按钮配置对象按钮所属表格的 DataTables API 实例。
`exportOptions`		{}
从 DataTable 中选择要用于导出的数据。这包括有关要导出哪些列、行、排序和搜索的选项。有关详细信息，请参见`buttons.exportData()`方法 - 此参数给出的对象将直接传送到该操作中，以收集所需数据。
`extension`		.pdf
要创建的文件名的扩展名。
`filename`		*
指定的文件名，为创建的文件（加上由`extension`选项定义的扩展名）。特殊字符 `*`会自动替换为从宿主文档的`title`标签读取的值。
`footer`		true
指示导出的数据是否应包括表格页脚。请注意，这个参数的默认值在 Buttons 3.0.1 中已更新为`true`。在早期版本中，它为`false`。
`header`		true
指示导出的数据是否应包括表格页眉。
`message`
`在创建的 PDF 中表格上方的可选描述信息。请注意，现已弃用此选项，转而使用`messageTop`选项。
`messageBottom` 自：1.4.0		*
显示在表格底部或在表格底部显示的`caption`标签的信息。
`messageTop` 自：1.4.0		*
显示在表格顶部或在表格顶部显示的`caption`标签的信息。
`orientation`		portrait
创建的 PDF 的纸张方向。可以为`portrait`或`landscape`。
`pageSize`		A4
创建的 PDF 的纸张大小。可以是`A3`、`A4`、`A5`、`LEGAL`、`LETTER`或`TABLOID`。
`text`		PDF
按钮的显示文本。可以通过此选项（请参阅`buttons.buttons.text`）或 DataTables `language`对象的`buttons.copy`选项配置文本。
`title`		*
文档标题（出现在生成的 PDF 中表格的上方）。特殊字符 `*`会自动替换为从宿主文档的`title`标签读取的值。

范例

DataTables 初始化：使用pdf按钮类型来引用 HTML 按钮选项。

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['pdf']
		}
	}
});

DataTables 初始化：使用exportOptions仅保存当前 DataTable 页面上显示的数据

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: [
				{
					extend: 'pdf',
					text: 'Save current page',
					exportOptions: {
						modifier: {
							page: 'current'
						}
					}
				}
			]
		}
	}
});