mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

📝 Update docs.

Browse source
This commit is contained in:
Haojian Wu 2015-06-11 15:04:58 +08:00
parent 559eb20e7f
commit f22662ffb2
1 changed files with 22 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
docs/api/browser-window.md
View file

@ -571,32 +571,6 @@ Calling `window.print()` in web page is equivalent to call
doesn't need print feature, you can safely remove `pdf.dll` in saving binary doesn't need print feature, you can safely remove `pdf.dll` in saving binary
size. size.
### BrowserWindow.printToPDF([options], callback)
* `options` Object
* `marginsType` Integer - Specify the type of margins to use
* 0 - default
* 1 - none
* 2 - minimum
* `shouldPrintBackgrounds` Boolean - Whether to print CSS backgrounds.
* `shouldPrintSelectionOnly` Boolean - Whether to print selection only.
* `landscape` Boolean - `true` for landscape, `false` for portrait.
* `callback` Function - `function(statusCode) {}`
* `statusCode` Integer
* 0 - Success.
* 1 - Fail to generate PDF file on renderer part.
* 2 - Fail to save PDF file on local disk.
* 3 - Users cancel the prompted save file dialog.
Prints windows' web page as PDF with Chromium's preview printing custom
settings. The API will prompt a SaveDialog to allow user custom the file path
for saving the generated PDF file on disk.
By default, the options will be
`{marginsType:0, shouldPrintBackgrounds:false, shouldPrintSelectionOnly:false,
landscape:false}`.
### BrowserWindow.loadUrl(url, [options]) ### BrowserWindow.loadUrl(url, [options])
Same with `webContents.loadUrl(url, [options])`. Same with `webContents.loadUrl(url, [options])`.
@ -976,6 +950,28 @@ Unregisters any serviceworker if present and returns boolean as
response to `callback` when the JS promise is fullfilled or false response to `callback` when the JS promise is fullfilled or false
when the JS promise is rejected. when the JS promise is rejected.
### WebContents.printToPDF(options, callback)
* `options` Object
* `marginsType` Integer - Specify the type of margins to use
* 0 - default
* 1 - none
* 2 - minimum
* `printBackground` Boolean - Whether to print CSS backgrounds.
* `printSelectionOnly` Boolean - Whether to print selection only.
* `landscape` Boolean - `true` for landscape, `false` for portrait.
* `callback` Function - `function(error, data) {}`
* `error` Error
* `data` Buffer - PDF file content
Prints windows' web page as PDF with Chromium's preview printing custom
settings.
By default, the options will be
`{marginsType:0, printBackgrounds:false, printSelectionOnly:false,
landscape:false}`.
### WebContents.send(channel[, args...]) ### WebContents.send(channel[, args...])
* `channel` String * `channel` String