github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
5c9050aea0
puppeteer/website/versioned_docs/version-10.0.0/puppeteer.screenshotoptions.md
TASNEEM KOUSHAR 34ff00e2fe
chore(docs): generate site for v10.0.0 
* fix: added parts of website

* fix: removed unnecessary lines

* fix: updated contributing.md

* fix: added parts of sidebar

* fix: added all APIs

* fix: added version 10.0.0

Co-authored-by: Jack Franklin <jacktfranklin@chromium.org>
2021-08-09 09:57:14 +01:00

1.7 KiB
Raw Blame History

Home > puppeteer > ScreenshotOptions

ScreenshotOptions interface

Signature:

export interface ScreenshotOptions

Properties

Property Type Description
captureBeyondViewport? boolean (Optional) If you need a screenshot bigger than the Viewport
clip? ScreenshotClip (Optional) An object which specifies the clipping region of the page.
encoding? 'base64' | 'binary' (Optional) Encoding of the image.
fullPage? boolean (Optional) When true, takes a screenshot of the full page.
omitBackground? boolean (Optional) Hides default white background and allows capturing screenshots with transparency.
path? string (Optional) The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
quality? number (Optional) Quality of the image, between 0-100. Not applicable to png images.
type? 'png' | 'jpeg' (Optional)