Optional
animationsOptional
caretWhen set to "hide"
, screenshot will hide text caret. When set to "initial"
, text caret behavior will not be
changed. Defaults to "hide"
.
Optional
clipAn object which specifies clipping of the resulting image.
height of clipping area
width of clipping area
x-coordinate of top-left corner of clip area
y-coordinate of top-left corner of clip area
Optional
fullWhen true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to
false
.
Optional
maskSpecify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
box #FF00FF
(customized by maskColor
) that completely covers its bounding box.
Optional
maskSpecify the color of the overlay box for masked elements, in
CSS color format. Default color is pink #FF00FF
.
Optional
omitHides default white background and allows capturing screenshots with transparency. Not applicable to jpeg
images.
Defaults to false
.
Optional
pathThe 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.
Optional
qualityThe quality of the image, between 0-100. Not applicable to png
images.
Optional
scaleWhen 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"
.
Optional
styleText 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.
Optional
timeoutMaximum time in milliseconds. Defaults to 0
- no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional
typeSpecify screenshot type, defaults to png
.
Generated using TypeDoc
When set to
"disabled"
, stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:transitionend
event.Defaults to
"allow"
that leaves animations untouched.