Slightly improve docs of webContents.printToPDF

This commit is contained in:
Cheng Zhao 2016-06-01 15:27:17 +09:00
parent 0864d3b1ee
commit 01b10b3b39

View file

@ -655,7 +655,8 @@ size.
* `marginsType` Integer - Specifies the type of margins to use. Uses 0 for * `marginsType` Integer - Specifies the type of margins to use. Uses 0 for
default margin, 1 for no margin, and 2 for minimum margin. default margin, 1 for no margin, and 2 for minimum margin.
* `pageSize` String - Specify page size of the generated PDF. Can be `A3`, * `pageSize` String - Specify page size of the generated PDF. Can be `A3`,
`A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height` & `width` in Microns. `A4`, `A5`, `Legal`, `Letter`, `Tabloid` or an Object containing `height`
and `width` in microns.
* `printBackground` Boolean - Whether to print CSS backgrounds. * `printBackground` Boolean - Whether to print CSS backgrounds.
* `printSelectionOnly` Boolean - Whether to print selection only. * `printSelectionOnly` Boolean - Whether to print selection only.
* `landscape` Boolean - `true` for landscape, `false` for portrait. * `landscape` Boolean - `true` for landscape, `false` for portrait.
@ -678,6 +679,8 @@ By default, an empty `options` will be regarded as:
} }
``` ```
An example of `webContents.printToPDF`:
```javascript ```javascript
const {BrowserWindow} = require('electron'); const {BrowserWindow} = require('electron');
const fs = require('fs'); const fs = require('fs');