Copy

Html2PdfOptions

Options supported by the PDF-oriented html2pdf.js compatibility layer.

ON_THIS_PAGE
  1. Signature
  2. Properties

Options supported by the PDF-oriented html2pdf.js compatibility layer.

Signature

export interface Html2PdfOptions {
    margin?: Margin;
    filename?: string;
    enableLinks?: boolean;
    pagebreak?: CompatPageBreakOptions;
    jsPDF?: CompatJsPdfOptions;
    html2canvas?: never;
    image?: never;
}
SOURCE:289

Properties

PropertyTypeRequiredRead onlyDefaultDescription
marginMarginNoNoNonePage margins in html2pdf.js order.
filenamestringNoNoNoneFilename used by save when no method argument is supplied.
enableLinksbooleanNoNoNonePreserves HTTP(S), mail, telephone, and FTP links unless explicitly disabled.
pagebreakCompatPageBreakOptionsNoNoNoneCompatibility pagination rules.
jsPDFCompatJsPdfOptionsNoNoNoneCompatibility page geometry.
html2canvasneverNoNoNoneUnsupported because this renderer does not use an html2canvas pipeline.
imageneverNoNoNoneUnsupported because PDF pages are not encoded as raster images.
ON_THIS_PAGE
  1. Signature
  2. Properties
html2realpdf documentationCopyright © Imggion
DOCUMENTATION_TREE