Interface Html2PdfOptions

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

Properties

displayHeaderFooter? footerTemplate? format? headerTemplate? height? landscape? margin? width?

Properties

Optional displayHeaderFooter

displayHeaderFooter?: boolean

Optional footerTemplate

footerTemplate?: string

Optional format

format?: Html2PdfFormats

One of Html2PdfFormats.
If set, takes priority over width or height options.
If neither format, nor width or height are set, 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

Settings

Member Visibility

Theme

Generated using TypeDoc