PDFOptions interface

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

Signature:

export interface PDFOptions

Properties

Property	Modifiers	Type	Description	Default
displayHeaderFooter	optional	boolean	Whether to show the header and footer.	false
footerTemplate	optional	string	HTML template for the print footer. Has the same constraints and support for special classes as PDFOptions.headerTemplate.
format	optional	PaperFormat		letter.
headerTemplate	optional	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	optional	string | number	Sets the height of paper. You can pass in a number or a string with a unit.
landscape	optional	boolean	Whether to print in landscape orientation.	false
margin	optional	PDFMargin	Set the PDF margins.	undefined no margins are set.
omitBackground	optional	boolean	Hides default white background and allows generating pdfs with transparency.	false
pageRanges	optional	string	Paper ranges to print, e.g. 1-5, 8, 11-13.	The empty string, which means all pages are printed.
path	optional	string	The path to save the file to.	undefined, which means the PDF will not be written to disk.
preferCSSPageSize	optional	boolean	Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.	false, which will scale the content to fit the paper size.
printBackground	optional	boolean	Set to true to print background graphics.	false
scale	optional	number	Scales the rendering of the web page. Amount must be between 0.1 and 2.	1
timeout	optional	number	Timeout in milliseconds. Pass 0 to disable timeout.	30_000
width	optional	string | number	Sets the width of paper. You can pass in a number or a string with a unit.