Back to Puppeteer

ScreenshotOptions interface

docs/api/puppeteer.screenshotoptions.md

19.2.22.3 KB
Original Source

ScreenshotOptions interface

Signature

typescript
export interface ScreenshotOptions

Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th><th>

Default

</th></tr></thead> <tbody><tr><td>

<span id="capturebeyondviewport">captureBeyondViewport</span>

</td><td>

optional

</td><td>

boolean

</td><td>

Capture the screenshot beyond the viewport.

</td><td>

false if there is no clip. true otherwise.

</td></tr> <tr><td>

<span id="clip">clip</span>

</td><td>

optional

</td><td>

ScreenshotClip

</td><td>

Specifies the region of the page/element to clip.

</td><td> </td></tr> <tr><td>

<span id="encoding">encoding</span>

</td><td>

optional

</td><td>

'base64' | 'binary'

</td><td>

Encoding of the image.

</td><td>

'binary'

</td></tr> <tr><td>

<span id="fromsurface">fromSurface</span>

</td><td>

optional

</td><td>

boolean

</td><td>

Capture the screenshot from the surface, rather than the view.

</td><td>

true

</td></tr> <tr><td>

<span id="fullpage">fullPage</span>

</td><td>

optional

</td><td>

boolean

</td><td>

When true, takes a screenshot of the full page.

</td><td>

false

</td></tr> <tr><td>

<span id="omitbackground">omitBackground</span>

</td><td>

optional

</td><td>

boolean

</td><td>

Hides default white background and allows capturing screenshots with transparency.

</td><td>

false

</td></tr> <tr><td>

<span id="optimizeforspeed">optimizeForSpeed</span>

</td><td>

optional

</td><td>

boolean

</td><td> </td><td>

false

</td></tr> <tr><td>

<span id="path">path</span>

</td><td>

optional

</td><td>

string

</td><td>

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.

</td><td> </td></tr> <tr><td>

<span id="quality">quality</span>

</td><td>

optional

</td><td>

number

</td><td>

Quality of the image, between 0-100. Not applicable to png images.

</td><td> </td></tr> <tr><td>

<span id="type">type</span>

</td><td>

optional

</td><td>

ImageFormat

</td><td> </td><td>

'png'

</td></tr> </tbody></table>