PDFOptions 接口

¥PDFOptions interface

通过 Page.pdf() 配置 PDF 生成的有效选项。

¥Valid options to configure PDF generation via Page.pdf().

签名：

¥Signature:

export interface PDFOptions

属性

¥Properties

属性	修饰符	类型	描述	默认
displayHeaderFooter	optional	boolean	是否显示页眉和页脚。	false
footerTemplate	optional	string	打印页脚的 HTML 模板。对特殊类具有与 PDFOptions.headerTemplate 相同的约束和支持。
format	optional	PaperFormat	评论： 如果设置，则该选项优先于 width 和 height 选项。	letter。
headerTemplate	optional	string	打印标题的 HTML 模板。应该是有效的 HTML，其中包含用于向其中注入值的以下类： date 格式的打印日期 title 文件标题 url 文档位置 pageNumber 当前页码 文档总页数 totalPages
height	optional	字符串| 数字	设置纸张的高度。你可以传入一个数字或带有单位的字符串。
landscape	optional	boolean	是否横向打印。	false
margin	optional	PDFMargin	设置 PDF 页边距。	undefined 未设置边距。
omitBackground	optional	boolean	隐藏默认的白色背景并允许生成具有透明度的 pdf。	false
outline	optional	boolean	（实验性）生成文档大纲。 评论： 如果启用此功能，PDF 也将被标记（可访问） 目前仅适用于旧版 Headless（headless = 'shell'）Chrom 功能请求	false
pageRanges	optional	string	要打印的纸张范围，例如 1-5, 8, 11-13。	空字符串，表示打印所有页面。
path	optional	string	文件保存的路径。 评论： 如果路径是相对路径，则相对于当前工作目录进行解析。	undefined，这意味着 PDF 不会写入磁盘。
首选 CSS 页面大小	optional	boolean	使页面中声明的任何 CSS @page 大小优先于 width 或 height 或 format 选项中声明的大小。	false，它将缩放内容以适合纸张尺寸。
printBackground	optional	boolean	设置为 true 以打印背景图形。	false
scale	optional	数字	缩放网页的渲染。金额必须介于 0.1 和 2 之间。	1
tagged	optional	boolean	（实验性）生成带标签的（可访问的）PDF。	true
timeout	optional	数字	超时（以毫秒为单位）。通过 0 禁用超时。	30_000
width	optional	字符串| 数字	设置纸张宽度。你可以传入一个数字或带有单位的字符串。