mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
e0932e5cce
🤖 I have created a release *beep* *boop* --- <details><summary>browsers: 2.2.2</summary> ## [2.2.2](https://github.com/puppeteer/puppeteer/compare/browsers-v2.2.1...browsers-v2.2.2) (2024-04-15) ### Bug Fixes * remove NetworkServiceInProcess2 set by default ([#12261](https://github.com/puppeteer/puppeteer/issues/12261)) ([ff4f70f](ff4f70f4ae)), closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257) </details> <details><summary>puppeteer: 22.6.5</summary> ## [22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-v22.6.4...puppeteer-v22.6.5) (2024-04-15) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 22.6.4 to 22.6.5 * @puppeteer/browsers bumped from 2.2.1 to 2.2.2 </details> <details><summary>puppeteer-core: 22.6.5</summary> ## [22.6.5](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v22.6.4...puppeteer-core-v22.6.5) (2024-04-15) ### Bug Fixes * remove NetworkServiceInProcess2 set by default ([#12261](https://github.com/puppeteer/puppeteer/issues/12261)) ([ff4f70f](ff4f70f4ae)), closes [#12257](https://github.com/puppeteer/puppeteer/issues/12257) * use setImmediate to reduce flakiness when processing events ([#12264](https://github.com/puppeteer/puppeteer/issues/12264)) ([73403b3](73403b323e)) ### Dependencies * The following workspace dependencies were updated * dependencies * @puppeteer/browsers bumped from 2.2.1 to 2.2.2 </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
396 lines
4.0 KiB
Markdown
396 lines
4.0 KiB
Markdown
---
|
|
sidebar_label: PDFOptions
|
|
---
|
|
|
|
# PDFOptions interface
|
|
|
|
Valid options to configure PDF generation via [Page.pdf()](./puppeteer.page.pdf.md).
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export interface PDFOptions
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th><th>
|
|
|
|
Default
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
<span id="displayheaderfooter">displayHeaderFooter</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Whether to show the header and footer.
|
|
|
|
</td><td>
|
|
|
|
`false`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="footertemplate">footerTemplate</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
HTML template for the print footer. Has the same constraints and support for special classes as [PDFOptions.headerTemplate](./puppeteer.pdfoptions.md#headertemplate).
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="format">format</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
[PaperFormat](./puppeteer.paperformat.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
`letter`.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="headertemplate">headerTemplate</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
HTML template for the print header. Should be valid HTML with the following classes used to inject values into them:
|
|
|
|
- `date` formatted print date
|
|
|
|
- `title` document title
|
|
|
|
- `url` document location
|
|
|
|
- `pageNumber` current page number
|
|
|
|
- `totalPages` total pages in the document
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="height">height</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string \| number
|
|
|
|
</td><td>
|
|
|
|
Sets the height of paper. You can pass in a number or a string with a unit.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="landscape">landscape</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Whether to print in landscape orientation.
|
|
|
|
</td><td>
|
|
|
|
`false`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="margin">margin</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
[PDFMargin](./puppeteer.pdfmargin.md)
|
|
|
|
</td><td>
|
|
|
|
Set the PDF margins.
|
|
|
|
</td><td>
|
|
|
|
`undefined` no margins are set.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="omitbackground">omitBackground</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Hides default white background and allows generating pdfs with transparency.
|
|
|
|
</td><td>
|
|
|
|
`false`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="outline">outline</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Generate document outline.
|
|
|
|
</td><td>
|
|
|
|
`false`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="pageranges">pageRanges</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
Paper ranges to print, e.g. `1-5, 8, 11-13`.
|
|
|
|
</td><td>
|
|
|
|
The empty string, which means all pages are printed.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="path">path</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
</td><td>
|
|
|
|
The path to save the file to.
|
|
|
|
</td><td>
|
|
|
|
`undefined`, which means the PDF will not be written to disk.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="prefercsspagesize">preferCSSPageSize</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Give any CSS `@page` size declared in the page priority over what is declared in the `width` or `height` or `format` option.
|
|
|
|
</td><td>
|
|
|
|
`false`, which will scale the content to fit the paper size.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="printbackground">printBackground</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Set to `true` to print background graphics.
|
|
|
|
</td><td>
|
|
|
|
`false`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="scale">scale</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
</td><td>
|
|
|
|
Scales the rendering of the web page. Amount must be between `0.1` and `2`.
|
|
|
|
</td><td>
|
|
|
|
`1`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="tagged">tagged</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
</td><td>
|
|
|
|
Generate tagged (accessible) PDF.
|
|
|
|
</td><td>
|
|
|
|
`true`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="timeout">timeout</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
</td><td>
|
|
|
|
Timeout in milliseconds. Pass `0` to disable timeout.
|
|
|
|
</td><td>
|
|
|
|
`30_000`
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
<span id="width">width</span>
|
|
|
|
</td><td>
|
|
|
|
`optional`
|
|
|
|
</td><td>
|
|
|
|
string \| number
|
|
|
|
</td><td>
|
|
|
|
Sets the width of paper. You can pass in a number or a string with a unit.
|
|
|
|
</td><td>
|
|
|
|
</td></tr>
|
|
</tbody></table>
|