From 33ad68f7a7f29b1f0409055dbcfb2dd67ef63e5d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 Nov 2013 14:39:10 +0800 Subject: [PATCH] doc: Explain BrowserWindow.capturePage. --- docs/api/browser/browser-window.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/api/browser/browser-window.md b/docs/api/browser/browser-window.md index 0977b07..eb9f6dd 100644 --- a/docs/api/browser/browser-window.md +++ b/docs/api/browser/browser-window.md @@ -290,6 +290,23 @@ Starts inspecting element at position (`x`, `y`). ### BrowserWindow.restartHangMonitorTimeout() +### BrowserWindow.capturePage([rect, ]callback) + +* `rect` Object - The area of page to be captured + * `x` + * `y` + * `width` + * `height` +* `callback` Function + +Captures the snapshot of page within `rect`, upon completion `callback` would be +called with `callback(image)`, the `image` is a `Buffer` that stores the PNG +encoded data of the snapshot. Omitting the `rect` would capture the whole +visible page. + +You can write received `image` directly to a `.png` file, or you can base64 +encode it and use data URL to embed the image in HTML. + ### BrowserWindow.getPageTitle() Returns the title of web page. -- 2.7.4