PDFOptions 接口

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

签名

export interface PDFOptions

属性

属性	修饰符	类型	描述	默认值
displayHeaderFooter	可选	布尔值	是否显示页眉和页脚。	false
footerTemplate	可选	字符串	用于打印页脚的 HTML 模板。具有与 PDFOptions.headerTemplate 相同的约束和对特殊类的支持。
format	可选	PaperFormat	备注 如果设置，则此项的优先级高于 width 和 height 选项。	letter.
headerTemplate	可选	字符串	用于打印页眉的 HTML 模板。应为有效的 HTML，其中使用以下类将值注入其中： date 格式化的打印日期 title 文档标题 url 文档位置 pageNumber 当前页码 totalPages 文档中的总页数
height	可选	字符串 | 数字	设置纸张的高度。可以传入一个数字或一个带有单位的字符串。
landscape	可选	布尔值	是否以横向方向打印。	false
margin	可选	PDFMargin	设置 PDF 边距。	undefined 不设置边距。
omitBackground	可选	布尔值	隐藏默认的白色背景，并允许生成具有透明度的 PDF。	false
outline	可选	布尔值	（实验性）生成文档大纲。	false
pageRanges	可选	字符串	要打印的纸张范围，例如 1-5, 8, 11-13。	空字符串，表示打印所有页面。
path	可选	字符串	保存文件的路径。 备注 如果路径是相对的，则它相对于当前工作目录解析。	undefined，表示 PDF 不会写入磁盘。
preferCSSPageSize	可选	布尔值	在 width 或 height 或 format 选项中声明的内容优先级高于页面中声明的任何 CSS @page 大小。	false，它将缩放内容以适应纸张大小。
printBackground	可选	布尔值	设置为 true 以打印背景图形。	false
scale	可选	数字	缩放网页的渲染。数值必须在 0.1 和 2 之间。	1
tagged	可选	布尔值	（实验性）生成带标签（可访问）的 PDF。	true
timeout	可选	数字	超时时间，以毫秒为单位。传递 0 以禁用超时。 默认值可以使用 Page.setDefaultTimeout() 进行更改	30_000
waitForFonts	可选	布尔值	如果为 true，则等待 document.fonts.ready 解析。如果页面在后台，则可能需要使用 Page.bringToFront() 激活页面。	true
width	可选	字符串 | 数字	设置纸张的宽度。可以传入一个数字或一个带有单位的字符串。