PDF options

All available options for the PDF API endpoints.

All options are optional

scale · number · default: 1

Required range: 0.1 <= x <= 2

Example:

displayHeaderFooter · boolean · default: false

Example:

headerHtml · string | null

footerHtml · string | null

printBackground · boolean · default: false

Example:

landscape · boolean · default: false

Example:

pageRanges · string | null

Example:

format · enum<string> · default: letter

Available options:

letter,

legal,

tabloid,

ledger,

a0,

a1,

a2,

a3,

a4,

a5,

a6

Example:

width

height

preferCSSPageSize · boolean · default: false

Example:

margin · object

Show child attributes

omitBackground · boolean · default: false

Example:

outline · boolean · default: false

Example:

tagged · boolean · default: false

Example: