PDFOptions interface

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

Signature:

export interface PDFOptions

Properties

Property	Type	Description
displayHeaderFooter	boolean	Whether to show the header and footer.
footerTemplate	string	HTML template for the print footer. Has the same constraints and support for special classes as PDFOptions.headerTemplate.
format	PaperFormat
headerTemplate	string	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
height	string \| number	Sets the height of paper. You can pass in a number or a string with a unit.
landscape	boolean	Whether to print in landscape orientation.
margin	PDFMargin	Set the PDF margins.
pageRanges	string	Paper ranges to print, e.g. `1-5, 8, 11-13`.
path	string	The path to save the file to.
preferCSSPageSize	boolean	Give any CSS `@page` size declared in the page priority over what is declared in the `width` or `height` or `format` option.
printBackground	boolean	Set to `true` to print background graphics.
scale	number	Scales the rendering of the web page. Amount must be between `0.1` and `2`.
width	string \| number	Sets the width of paper. You can pass in a number or a string with a unit.