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
4437bceb6e
puppeteer/docs/api/puppeteer.screenshotoptions.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150) 
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

4.8 KiB
Raw Blame History

sidebar_label
ScreenshotOptions

ScreenshotOptions interface

Signature:

export interface ScreenshotOptions

Properties

Property Modifiers Type Description Default
captureBeyondViewport? boolean (Optional) Capture the screenshot beyond the viewport. true
clip? ScreenshotClip (Optional) An object which specifies the clipping region of the page.
encoding? 'base64' | 'binary' (Optional) Encoding of the image. binary
fromSurface? boolean (Optional) Capture the screenshot from the surface, rather than the view. true
fullPage? boolean (Optional) When true, takes a screenshot of the full page. false
omitBackground? boolean (Optional) Hides default white background and allows capturing screenshots with transparency. false
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' | 'webp' (Optional) png