| sidebar_label |
|---|
PDFOptions |
Valid options to configure PDF generation via Page.pdf().
export interface PDFOptions| Property | Modifiers | Type | Description | Default |
|---|---|---|---|---|
| displayHeaderFooter? | boolean | (Optional) Whether to show the header and footer. | false | |
| footerTemplate? | string | (Optional) HTML template for the print footer. Has the same constraints and support for special classes as PDFOptions.headerTemplate. | ||
| format? | PaperFormat | (Optional) | letter. |
|
| headerTemplate? | string | (Optional) HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: - - - - - |
||
| height? | string | number | (Optional) Sets the height of paper. You can pass in a number or a string with a unit. | ||
| landscape? | boolean | (Optional) Whether to print in landscape orientation. | = false | |
| margin? | PDFMargin | (Optional) Set the PDF margins. | no margins are set. | |
| omitBackground? | boolean | (Optional) Hides default white background and allows generating pdfs with transparency. | false | |
| pageRanges? | string | (Optional) Paper ranges to print, e.g. 1-5, 8, 11-13. |
The empty string, which means all pages are printed. | |
| path? | string | (Optional) The path to save the file to. | the empty string, which means the PDF will not be written to disk. | |
| preferCSSPageSize? | boolean | (Optional) Give any CSS @page size declared in the page priority over what is declared in the width or height or format option. |
false, which will scale the content to fit the paper size. |
|
| printBackground? | boolean | (Optional) Set to true to print background graphics. |
false | |
| scale? | number | (Optional) Scales the rendering of the web page. Amount must be between 0.1 and 2. |
1 | |
| timeout? | number | (Optional) Timeout in milliseconds. Pass 0 to disable timeout. |
30000 | |
| width? | string | number | (Optional) Sets the width of paper. You can pass in a number or a string with a unit. |