Options supported by the PDF-oriented html2pdf.js compatibility layer.
Signature
export interface Html2PdfOptions {
metadata?: PdfMetadata;
conformance?: "pdfa-3u";
attachments?: readonly PdfAttachment[];
margin?: Margin;
filename?: string;
enableLinks?: boolean;
pagebreak?: CompatPageBreakOptions;
jsPDF?: CompatJsPdfOptions;
html2canvas?: never;
image?: never;
}Properties
| Property | Type | Required | Read only | Default | Description |
|---|---|---|---|---|---|
metadata | PdfMetadata | No | No | None | Same metadata and archival options as RenderOptions. |
conformance | "pdfa-3u" | No | No | None | Not documented. |
attachments | readonly PdfAttachment[] | No | No | None | Not documented. |
margin | Margin | No | No | None | Page margins in html2pdf.js order. |
filename | string | No | No | None | Filename used by save when no method argument is supplied. |
enableLinks | boolean | No | No | None | Preserves HTTP(S), mail, telephone, and FTP links unless explicitly disabled. |
pagebreak | CompatPageBreakOptions | No | No | None | Compatibility pagination rules. |
jsPDF | CompatJsPdfOptions | No | No | None | Compatibility page geometry. |
html2canvas | never | No | No | None | Unsupported because this renderer does not use an html2canvas pipeline. |
image | never | No | No | None | Unsupported because PDF pages are not encoded as raster images. |