com.microsoft.playwright

Class ElementHandle.ScreenshotOptions

java.lang.Object

com.microsoft.playwright.ElementHandle.ScreenshotOptions

Enclosing interface:

ElementHandle

public static class ElementHandle.ScreenshotOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
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
ElementHandle.ScreenshotOptions	setOmitBackground(boolean omitBackground) Hides default white background and allows capturing screenshots with transparency.
ElementHandle.ScreenshotOptions	setPath(Path path) The file path to save the image to.
ElementHandle.ScreenshotOptions	setQuality(int quality) The quality of the image, between 0-100.
ElementHandle.ScreenshotOptions	setTimeout(double timeout) Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
ElementHandle.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

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

setOmitBackground

public ElementHandle.ScreenshotOptions setOmitBackground(boolean omitBackground)

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

setPath

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

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

setTimeout

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

Specify screenshot type, defaults to png.