com.microsoft.playwright

Class Page.ScreenshotOptions

java.lang.Object

com.microsoft.playwright.Page.ScreenshotOptions

Enclosing interface:

Page

public static class Page.ScreenshotOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Clip	clip An object which specifies clipping of the resulting image.
Boolean	fullPage When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport.
Boolean	omitBackground Hides default white background and allows capturing screenshots with transparency.
Path	path The file path to save the image to.
Integer	quality The quality of the image, between 0-100.
Double	timeout Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
ScreenshotType	type Specify screenshot type, defaults to png.

Constructor Summary

Constructors

Constructor and Description
ScreenshotOptions()

Method Summary

Modifier and Type	Method and Description
Page.ScreenshotOptions	setClip(Clip clip)
Page.ScreenshotOptions	setClip(double x, double y, double width, double height)
Page.ScreenshotOptions	setFullPage(boolean fullPage)
Page.ScreenshotOptions	setOmitBackground(boolean omitBackground)
Page.ScreenshotOptions	setPath(Path path)
Page.ScreenshotOptions	setQuality(int quality)
Page.ScreenshotOptions	setTimeout(double timeout)
Page.ScreenshotOptions	setType(ScreenshotType type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clip

public Clip clip

An object which specifies clipping of the resulting image. Should have the following fields:

fullPage

public Boolean fullPage

When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to false.

omitBackground

public Boolean omitBackground

Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

path

public Path path

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 the current working directory. If no path is provided, the image won't be saved to the disk.

quality

public Integer quality

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

timeout

public Double timeout

Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

type

public ScreenshotType type

Specify screenshot type, defaults to png.

Constructor Detail

ScreenshotOptions

public ScreenshotOptions()

Method Detail

setClip

public Page.ScreenshotOptions setClip(double x,
                                      double y,
                                      double width,
                                      double height)

setClip

public Page.ScreenshotOptions setClip(Clip clip)

setFullPage

public Page.ScreenshotOptions setFullPage(boolean fullPage)

setOmitBackground

public Page.ScreenshotOptions setOmitBackground(boolean omitBackground)

setPath

public Page.ScreenshotOptions setPath(Path path)

setQuality

public Page.ScreenshotOptions setQuality(int quality)

setTimeout

public Page.ScreenshotOptions setTimeout(double timeout)

setType

public Page.ScreenshotOptions setType(ScreenshotType type)