Package com.microsoft.playwright

Class ElementHandle.ScreenshotOptions

java.lang.Object

com.microsoft.playwright.ElementHandle.ScreenshotOptions

Enclosing interface:

ElementHandle

public static class ElementHandle.ScreenshotOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElementHandle.ScreenshotOptions.Type

Field Summary

Fields

Modifier and Type	Field	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.
Integer	timeout	Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
ElementHandle.ScreenshotOptions.Type	type	Specify screenshot type, defaults to png.

Constructor Summary

Constructors

Constructor	Description
ScreenshotOptions()

Method Summary

Modifier and Type	Method	Description
ElementHandle.ScreenshotOptions	withOmitBackground(Boolean omitBackground)
ElementHandle.ScreenshotOptions	withPath(Path path)
ElementHandle.ScreenshotOptions	withQuality(Integer quality)
ElementHandle.ScreenshotOptions	withTimeout(Integer timeout)
ElementHandle.ScreenshotOptions	withType(ElementHandle.ScreenshotOptions.Type type)

Methods inherited from class java.lang.Object

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

Field Detail

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

type

public ElementHandle.ScreenshotOptions.Type type

Specify screenshot type, defaults to png.

quality

public Integer quality

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

omitBackground

public Boolean omitBackground

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

timeout

public Integer 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(timeout) or page.setDefaultTimeout(timeout) methods.

Constructor Detail

ScreenshotOptions

public ScreenshotOptions()

Method Detail

withPath

public ElementHandle.ScreenshotOptions withPath(Path path)

withType

public ElementHandle.ScreenshotOptions withType(ElementHandle.ScreenshotOptions.Type type)

withQuality

public ElementHandle.ScreenshotOptions withQuality(Integer quality)

withOmitBackground

public ElementHandle.ScreenshotOptions withOmitBackground(Boolean omitBackground)

withTimeout

public ElementHandle.ScreenshotOptions withTimeout(Integer timeout)