PDFOptions 接口
通过 Page.pdf() 配置 PDF 生成的有效选项。
签名:
export interface PDFOptions
属性
| 属性 | 修饰符 | 类型 | 描述 | 默认值 |
|---|---|---|---|---|
| displayHeaderFooter | 可选 | 布尔值 | 是否显示页眉和页脚。 | false |
| footerTemplate | 可选 | 字符串 | 打印页脚的 HTML 模板。与 PDFOptions.headerTemplate 具有相同的约束和对特殊类的支持。 | |
| 格式 | 可选 | PaperFormat | letter. | |
| headerTemplate | 可选 | 字符串 | 打印页眉的 HTML 模板。应为有效的 HTML，使用以下类将值注入其中 - - - - - | |
| 高度 | 可选 | 字符串 | 数字 | 设置纸张高度。您可以传入一个数字或带有单位的字符串。 | |
| 横向 | 可选 | 布尔值 | 是否以横向打印。 | false |
| 边距 | 可选 | PDFMargin | 设置 PDF 边距。 | undefined 未设置边距。 |
| omitBackground | 可选 | 布尔值 | 隐藏默认的白色背景，并允许生成具有透明度的 PDF。 | false |
| 大纲 | 可选 | 布尔值 | 生成文档大纲。 | false |
| pageRanges | 可选 | 字符串 | 要打印的纸张范围，例如 1-5, 8, 11-13。 | 空字符串，表示打印所有页面。 |
| 路径 | 可选 | 字符串 | 保存文件的路径。 | undefined，表示 PDF 不会写入磁盘。 |
| preferCSSPageSize | 可选 | 布尔值 | 优先考虑页面中声明的任何 CSS @page 大小，而不是 width 或 height 或 format 选项中声明的大小。 | false，这将缩放内容以适合纸张大小。 |
| printBackground | 可选 | 布尔值 | 设置为 true 以打印背景图形。 | false |
| 缩放 | 可选 | 数字 | 缩放网页的渲染。金额必须介于 0.1 和 2 之间。 | 1 |
| 标记 | 可选 | 布尔值 | 生成标记的（可访问的）PDF。 | true |
| 超时 | 可选 | 数字 | 以毫秒为单位的超时。传递 0 以禁用超时。 | 30_000 |
| 宽度 | 可选 | 字符串 | 数字 | 设置纸张宽度。您可以传入一个数字或带有单位的字符串。 |