Skip to main content
Version: Next

PDFOptions interface

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


export interface PDFOptions


displayHeaderFooter?boolean(Optional) Whether to show the header and footer.
footerTemplate?string(Optional) HTML template for the print footer. Has the same constraints and support for special classes as PDFOptions.headerTemplate.

(Optional) 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(Optional) Sets the height of paper. You can pass in a number or a string with a unit.
landscape?boolean(Optional) Whether to print in landscape orientation.
margin?PDFMargin(Optional) Set the PDF margins.
omitBackground?boolean(Optional) Hides default white background and allows generating pdfs with transparency.
pageRanges?string(Optional) Paper ranges to print, e.g. 1-5, 8, 11-13.
path?string(Optional) The path to save the file to.
preferCSSPageSize?boolean(Optional) Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
printBackground?boolean(Optional) Set to true to print background graphics.
scale?number(Optional) Scales the rendering of the web page. Amount must be between 0.1 and 2.
timeout?number(Optional) Timeout in milliseconds
width?string | number(Optional) Sets the width of paper. You can pass in a number or a string with a unit.