UNPKG

pdf-master

Version:

"npm package to generate static and dynamic PDF in nodejs."

github.com/chaitanyamogal/pdf-master

chaitanyamogal/pdf-master

67 lines (51 loc) • 3.2 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
## PDF formating options ```js var PDF = pdfMaster.generatePdf("template.hbs", data, options); ``` `options` <Object> Options object which might have the following properties: - `path` <string> The file path to save the PDF to. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the PDF won't be saved to the disk. - `scale` <number> Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2. - `displayHeaderFooter` <boolean> Display header and footer. Defaults to false. - `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 - `footerTemplate` <string> HTML template for the print footer. Should use the same format as the headerTemplate. - `printBackground` <boolean> Print background graphics. Defaults to false. - `landscape` <boolean> Paper orientation. Defaults to false. - `pageRanges` <string> Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages. - `format` <string> Paper format. If set, takes priority over width or height options. Defaults to 'Letter'. - `width` <string|number> Paper width, accepts values labeled with units. - `height` <string|number> Paper height, accepts values labeled with units. - `margin` <Object> Paper margins, defaults to none. - `top` <string|number> Top margin, accepts values labeled with units. - `right` <string|number> Right margin, accepts values labeled with units. - `bottom` <string|number> Bottom margin, accepts values labeled with units. - `left` <string|number> Left margin, accepts values labeled with units. - `preferCSSPageSize` <boolean> Give any CSS @page size declared in the page priority over what is declared in width and height or format options. Defaults to false, which will scale the content to fit the paper size. `returns`: <Promise<Buffer>> Promise which resolves with PDF buffer. NOTE Generating a pdf is currently only supported in Chrome headless. NOTE By default, `pdfMaster.generatePdf()` generates a pdf with modified colors for printing. Use the -webkit-print-color-adjust property to force rendering of exact colors. The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as pixels. #### All possible `units` are: - `px` - pixel - `in` - inch - `cm` - centimeter - `mm` - millimeter #### The `format` options are: - `Letter`: 8.5in x 11in - `Legal`: 8.5in x 14in - `Tabloid`: 11in x 17in - `Ledger`: 17in x 11in - `A0`: 33.1in x 46.8in - `A1`: 23.4in x 33.1in - `A2`: 16.54in x 23.4in - `A3`: 11.7in x 16.54in - `A4`: 8.27in x 11.7in - `A5`: 5.83in x 8.27in - `A6`: 4.13in x 5.83in NOTE `headerTemplate` and `footerTemplate` markup have the following limitations: 1. Script tags inside templates are not evaluated. 2. Page styles are not visible inside templates.