com.microsoft.playwright

Class Locator.ScreenshotOptions

java.lang.Object

com.microsoft.playwright.Locator.ScreenshotOptions

Enclosing interface:

Locator

public static class Locator.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.
ScreenshotCaret	caret When set to "hide", screenshot will hide text caret.
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.
ScreenshotScale	scale When set to "css", screenshot will have a single pixel per each css pixel on the page.
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
Locator.ScreenshotOptions	setAnimations(ScreenshotAnimations animations) When set to "disabled", stops CSS animations, CSS transitions and Web Animations.
Locator.ScreenshotOptions	setCaret(ScreenshotCaret caret) When set to "hide", screenshot will hide text caret.
Locator.ScreenshotOptions	setMask(List<Locator> mask) Specify locators that should be masked when the screenshot is taken.
Locator.ScreenshotOptions	setOmitBackground(boolean omitBackground) Hides default white background and allows capturing screenshots with transparency.
Locator.ScreenshotOptions	setPath(Path path) The file path to save the image to.
Locator.ScreenshotOptions	setQuality(int quality) The quality of the image, between 0-100.
Locator.ScreenshotOptions	setScale(ScreenshotScale scale) When set to "css", screenshot will have a single pixel per each css pixel on the page.
Locator.ScreenshotOptions	setTimeout(double timeout) Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
Locator.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.

Defaults to "allow" that leaves animations untouched.

caret

public ScreenshotCaret caret

When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".

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.

scale

public ScreenshotScale scale

When set to "css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using "device" option will produce a single pixel per each device pixel, so screenhots of high-dpi devices will be twice as large or even larger. Defaults to "device".

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 Locator.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.

Defaults to "allow" that leaves animations untouched.

setCaret

public Locator.ScreenshotOptions setCaret(ScreenshotCaret caret)

When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".

setMask

public Locator.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 Locator.ScreenshotOptions setOmitBackground(boolean omitBackground)

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

setPath

public Locator.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 Locator.ScreenshotOptions setQuality(int quality)

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

setScale

public Locator.ScreenshotOptions setScale(ScreenshotScale scale)

When set to "css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using "device" option will produce a single pixel per each device pixel, so screenhots of high-dpi devices will be twice as large or even larger. Defaults to "device".

setTimeout

public Locator.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 Locator.ScreenshotOptions setType(ScreenshotType type)

Specify screenshot type, defaults to png.