Options
All
  • Public
  • Public/Protected
  • All
Menu

See Pupeteer docs for further details regarding the exposed options.

Note:
You can only use the options mentioned here even though the Pupeteer docs describe some more.
Please let us know if you'd need other options as well.

Hierarchy

  • Html2PdfOptions

Index

Properties

Optional displayHeaderFooter

displayHeaderFooter: boolean

Optional footerTemplate

footerTemplate: string

Optional format

format: Letter | Legal | Tabloid | Ledger | A0 | A1 | A2 | A3 | A4 | A5 | A6

One of Cbn.Enums.Html2PdfFormats.
If set, takes priority over width or height options.
If neither format, nor width or height are set, Cbn.Enums.Html2PdfFormats.A4 is used as fallback.

Optional headerTemplate

headerTemplate: string

Optional height

height: string | number

Only takes effect if no format is set

Optional landscape

landscape: boolean

Optional margin

margin: { bottom?: string | number; left?: string | number; right?: string | number; top?: string | number }

Type declaration

  • Optional bottom?: string | number
  • Optional left?: string | number
  • Optional right?: string | number
  • Optional top?: string | number

Optional width

width: string | number

Only takes effect if no format is set

Generated using TypeDoc