displayHeaderFooter? | boolean | Display header and footer. Defaults to false |
footerTemplate? | string | HTML template for the print footer. Should use the same format as the headerTemplate. |
format? | PDFPageFormat | The page format to use for the PDF |
fullPage? | boolean | When true, sizes the PDF page height to the full scroll height of the document so the entire page renders on a single page. Mutually exclusive with "format" and "height". Default: False |
generateDocumentOutline? | boolean | Whether or not to embed the document outline into the PDF |
generateTaggedPDF? | boolean | Whether or not to generate tagged (accessible) PDF. Defaults to embedded choice |
headerTemplate? | string | HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document For example, <span class=title></span> would generate span containing the title |
height? | string | number | Height in inches or CSS unit. Defaults to 11 inches |
landscape? | boolean | Paper orientation. Defaults to false |
marginBottom? | string | number | Bottom margin in inches or CSS unit. Defaults to 1cm (~0.4 inches). |
marginLeft? | string | number | Left margin in inches or CSS unit. Defaults to 1cm (~0.4 inches). |
marginRight? | string | number | Right margin in inches or CSS unit. Defaults to 1cm (~0.4 inches). |
marginTop? | string | number | Top margin in inches or CSS unit. Defaults to 1cm (~0.4 inches). |
omitBackground? | boolean | Hides the default white background and allows the PDF to preserve transparency. Defaults to false. |
pageRanges? | string | Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end |
path? | string | - |
preferCSSPageSize? | boolean | Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size |
printBackground? | boolean | Print background graphics. Defaults to false |
scale? | number | Scale of the webpage rendering. Defaults to 1 |
timeout? | number | The maximum amount of time, in milliseconds, to wait for the PDF to be generated. Default timeout is 30 seconds, or 30000. |
transferMode? | string | Return as stream (PrintToPDFRequestTransferMode enum) |
waitForFonts? | boolean | When true, waits for document fonts to finish loading before generating the PDF. Default: False |
waitForImages? | boolean | When true, waits for all images on the page to load before generating the PDF. Default: False |
width? | string | number | Width in inches or CSS unit. Defaults to 8.5 inches |