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
ec8c750383
puppeteer/website/versioned_docs/version-15.3.1/api/puppeteer.screenshotoptions.md
release-please[bot] ec8c750383
chore(main): release 15.3.1 (#8635) 
* chore(main): release 15.3.1

* chore: generate versioned docs

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2022-07-06 09:24:46 +02:00

4.6 KiB
Raw Blame History

sidebar_label
ScreenshotOptions

ScreenshotOptions interface

Signature:

export interface ScreenshotOptions

Properties

Property Modifiers Type Description
captureBeyondViewport? boolean (Optional) Capture the screenshot beyond the viewport.
clip? ScreenshotClip (Optional) An object which specifies the clipping region of the page.
encoding? 'base64' | 'binary' (Optional) Encoding of the image.
fromSurface? boolean (Optional) Capture the screenshot from the surface, rather than the view.
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' | 'webp' (Optional)