Package com.microsoft.playwright
Class Page.ScreenshotOptions
- java.lang.Object
-
- com.microsoft.playwright.Page.ScreenshotOptions
-
-
Field Summary
Fields Modifier and Type Field 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.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.String
maskColor
Specify the color of the overlay box for masked elements, in CSS color format.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.String
style
Text of the stylesheet to apply while making the screenshot.Double
timeout
Maximum time in milliseconds.ScreenshotType
type
Specify screenshot type, defaults topng
.
-
Constructor Summary
Constructors Constructor Description ScreenshotOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Page.ScreenshotOptions
setAnimations(ScreenshotAnimations animations)
When set to"disabled"
, stops CSS animations, CSS transitions and Web Animations.Page.ScreenshotOptions
setCaret(ScreenshotCaret caret)
When set to"hide"
, screenshot will hide text caret.Page.ScreenshotOptions
setClip(double x, double y, double width, double height)
An object which specifies clipping of the resulting image.Page.ScreenshotOptions
setClip(Clip clip)
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
setMaskColor(String maskColor)
Specify the color of the overlay box for masked elements, in CSS color format.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
setScale(ScreenshotScale scale)
When set to"css"
, screenshot will have a single pixel per each css pixel on the page.Page.ScreenshotOptions
setStyle(String style)
Text of the stylesheet to apply while making the screenshot.Page.ScreenshotOptions
setTimeout(double timeout)
Maximum time in milliseconds.Page.ScreenshotOptions
setType(ScreenshotType type)
Specify screenshot type, defaults topng
.
-
-
-
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. - finite animations are fast-forwarded to completion, so they'll fire
-
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"
.
-
clip
public Clip clip
An object which specifies clipping of the resulting image.
-
fullPage
public Boolean fullPage
When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults tofalse
.
-
mask
public List<Locator> mask
Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box#FF00FF
(customized bymaskColor
) that completely covers its bounding box.
-
maskColor
public String maskColor
Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink#FF00FF
.
-
omitBackground
public Boolean omitBackground
Hides default white background and allows capturing screenshots with transparency. Not applicable tojpeg
images. Defaults tofalse
.
-
path
public Path path
The file path to save the image to. The screenshot type will be inferred from file extension. Ifpath
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 topng
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 screenshots of high-dpi devices will be twice as large or even larger.Defaults to
"device"
.
-
style
public String style
Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.
-
timeout
public Double timeout
Maximum time in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using theBrowserContext.setDefaultTimeout()
orPage.setDefaultTimeout()
methods.
-
type
public ScreenshotType type
Specify screenshot type, defaults topng
.
-
-
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.
Defaults to
"allow"
that leaves animations untouched. - finite animations are fast-forwarded to completion, so they'll fire
-
setCaret
public Page.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"
.
-
setClip
public Page.ScreenshotOptions setClip(double x, double y, double width, double height)
An object which specifies clipping of the resulting image.
-
setClip
public Page.ScreenshotOptions setClip(Clip clip)
An object which specifies clipping of the resulting image.
-
setFullPage
public Page.ScreenshotOptions setFullPage(boolean fullPage)
When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults tofalse
.
-
setMask
public Page.ScreenshotOptions setMask(List<Locator> mask)
Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box#FF00FF
(customized bymaskColor
) that completely covers its bounding box.
-
setMaskColor
public Page.ScreenshotOptions setMaskColor(String maskColor)
Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink#FF00FF
.
-
setOmitBackground
public Page.ScreenshotOptions setOmitBackground(boolean omitBackground)
Hides default white background and allows capturing screenshots with transparency. Not applicable tojpeg
images. Defaults tofalse
.
-
setPath
public Page.ScreenshotOptions setPath(Path path)
The file path to save the image to. The screenshot type will be inferred from file extension. Ifpath
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 topng
images.
-
setScale
public Page.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 screenshots of high-dpi devices will be twice as large or even larger.Defaults to
"device"
.
-
setStyle
public Page.ScreenshotOptions setStyle(String style)
Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.
-
setTimeout
public Page.ScreenshotOptions setTimeout(double timeout)
Maximum time in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using theBrowserContext.setDefaultTimeout()
orPage.setDefaultTimeout()
methods.
-
setType
public Page.ScreenshotOptions setType(ScreenshotType type)
Specify screenshot type, defaults topng
.
-
-