Package com.microsoft.playwright

Class Page.ScreenshotOptions

java.lang.Object

com.microsoft.playwright.Page.ScreenshotOptions

Enclosing interface:

Page

public static class Page.ScreenshotOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Page.ScreenshotOptions.Clip
static class	Page.ScreenshotOptions.Type

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ScreenshotOptions()

Method Summary

Modifier and Type	Method	Description
Page.ScreenshotOptions.Clip	setClip()
Page.ScreenshotOptions	withFullPage(Boolean fullPage)
Page.ScreenshotOptions	withOmitBackground(Boolean omitBackground)
Page.ScreenshotOptions	withPath(Path path)
Page.ScreenshotOptions	withQuality(Integer quality)
Page.ScreenshotOptions	withTimeout(Integer timeout)
Page.ScreenshotOptions	withType(Page.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 Page.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.

fullPage

public Boolean fullPage

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

clip

public Page.ScreenshotOptions.Clip clip

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

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 Page.ScreenshotOptions withPath(Path path)

withType

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

withQuality

public Page.ScreenshotOptions withQuality(Integer quality)

withFullPage

public Page.ScreenshotOptions withFullPage(Boolean fullPage)

setClip

public Page.ScreenshotOptions.Clip setClip()

withOmitBackground

public Page.ScreenshotOptions withOmitBackground(Boolean omitBackground)

withTimeout

public Page.ScreenshotOptions withTimeout(Integer timeout)