PDFOptions 接口

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

string | number

设置纸张的高度。你可以传入一个数字或带单位的字符串。

landscape

optional

boolean

是否以横向方向打印。

false

margin

optional

PDFMargin

设置 PDF 的页边距。

undefined 表示未设置页边距。

omitBackground

optional

boolean

隐藏默认的白色背景，并允许生成带透明度的 PDF。

false

outline

optional

boolean

(实验性) 生成文档大纲。

false

pageRanges

optional

string

要打印的纸张范围，例如 1-5, 8, 11-13。

空字符串，表示打印所有页面。

path

optional

string

保存文件的目标路径。

备注：

如果路径是相对路径，则相对于当前工作目录进行解析。

undefined，表示 PDF 不会写入磁盘。

preferCSSPageSize

optional

boolean

让页面中声明的任何 CSS @page 大小优先于 width、height 或 format 选项中声明的内容。

false，将缩放内容以适应纸张大小。

printBackground

optional

boolean

设置为 true 以打印背景图形。

false

scale

optional

number

缩放网页的渲染。缩放值必须在 0.1 和 2 之间。

1

tagged

optional

boolean

(实验性) 生成带标签（无障碍）的 PDF。

true

timeout

optional

number

超时时间，单位为毫秒。传入 0 以禁用超时。

默认值可以通过使用 Page.setDefaultTimeout() 更改。

30_000

waitForFonts

optional

boolean

如果为 true，则等待 document.fonts.ready 解析。如果页面在后台，这可能需要使用 Page.bringToFront() 激活页面。

true

width

optional

string | number

设置纸张的宽度。你可以传入一个数字或带单位的字符串。