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
ScreenshotAnimations	animations When set to "disabled", stops CSS animations, CSS transitions and Web Animations.
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.
List<Locator>	mask Specify locators that should be masked when the screenshot is taken.
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	setAnimations(ScreenshotAnimations animations) When set to "disabled", stops CSS animations, CSS transitions and Web Animations.
Page.ScreenshotOptions	setClip(Clip clip) An object which specifies clipping of the resulting image.
Page.ScreenshotOptions	setClip(double x, double y, double width, double height) An object which specifies clipping of the resulting image.
Page.ScreenshotOptions	setFullPage(boolean fullPage) When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport.
Page.ScreenshotOptions	setMask(List<Locator> mask) Specify locators that should be masked when the screenshot is taken.
Page.ScreenshotOptions	setOmitBackground(boolean omitBackground) Hides default white background and allows capturing screenshots with transparency.
Page.ScreenshotOptions	setPath(Path path) The file path to save the image to.
Page.ScreenshotOptions	setQuality(int quality) The quality of the image, between 0-100.
Page.ScreenshotOptions	setTimeout(double timeout) Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
Page.ScreenshotOptions	setType(ScreenshotType type) Specify screenshot type, defaults to png.

Methods inherited from class java.lang.Object

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

Field Detail

animations

public ScreenshotAnimations animations

When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:

• finite animations are fast-forwarded to completion, so they'll fire transitionend event.
• infinite animations are canceled to initial state, and then played over after the screenshot.

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.

mask

public List<Locator> mask

Specify locators that should be masked when the screenshot is taken. Masked elements will be overlayed with a pink box #FF00FF that completely covers its bounding box.

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

setAnimations

public Page.ScreenshotOptions setAnimations(ScreenshotAnimations animations)

When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:

• finite animations are fast-forwarded to completion, so they'll fire transitionend event.
• infinite animations are canceled to initial state, and then played over after the screenshot.

setClip

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

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

setClip

public Page.ScreenshotOptions setClip(Clip clip)

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

setFullPage

public Page.ScreenshotOptions setFullPage(boolean fullPage)

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

setMask

public Page.ScreenshotOptions setMask(List<Locator> mask)

Specify locators that should be masked when the screenshot is taken. Masked elements will be overlayed with a pink box #FF00FF that completely covers its bounding box.

setOmitBackground

public Page.ScreenshotOptions setOmitBackground(boolean omitBackground)

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

setPath

public Page.ScreenshotOptions setPath(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.

setQuality

public Page.ScreenshotOptions setQuality(int quality)

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

setTimeout

public Page.ScreenshotOptions setTimeout(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.

setType

public Page.ScreenshotOptions setType(ScreenshotType type)

Specify screenshot type, defaults to png.