Skip to main content
All options are optional
​
scale
number
default:1

Scales the rendering of the web page. Amount must be between 0.1 and 2.

Required range: 0.1 <= x <= 2
Example:

1

​
displayHeaderFooter
boolean
default:false

Whether to show the header and footer.

Example:

false

​
headerHtml
string | null

HTML template for the print header. Should be valid HTML (base64 encoded) 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
​
footerHtml
string | null

HTML template for the print footer. Has the same constraints and support for special classes as headerHtml.

​
printBackground
boolean
default:false

Set to true to print background graphics.

Example:

false

​
landscape
boolean
default:false

Whether to print in landscape orientation.

Example:

false

​
pageRanges
string | null

Paper ranges to print, e.g. 1-5, 8, 11-13.

Example:

"1-5"

​
format
enum<string>
default:letter

If set, this takes priority over the width and height options. The sizes of each format are as follows:

  • letter 8.5in x 11in
  • legal 8.5in x 14in
  • tabloid 11in x 17in
  • ledger 17in x 11in
  • a0 33.1in x 46.8in
  • a1 23.4in x 33.1in
  • a2 16.54in x 23.4in
  • a3 11.7in x 16.54in
  • a4 8.27in x 11.7in
  • a5 5.83in x 8.27in
  • a6 4.13in x 5.83in
Available options:
letter,
legal,
tabloid,
ledger,
a0,
a1,
a2,
a3,
a4,
a5,
a6
Example:

"letter"

​
width

Sets the width of paper. You can pass in a number or a string with a unit.

​
height

Sets the height of paper. You can pass in a number or a string with a unit.

​
preferCSSPageSize
boolean
default:false

Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.

Example:

false

​
margin
object | null

Set the PDF margins.

​
omitBackground
boolean
default:false

Hides default white background and allows generating pdfs with transparency.

Example:

false

​
outline
boolean
default:false

Generate document outline. If this is enabled the PDF will also be tagged (accessible).

Example:

false

​
tagged
boolean
default:false

Generate tagged (accessible) PDF. This is experimental and will increase the size of the PDF.

Example:

false