Interface LocatorScreenshotOptions

Hierarchy

  • LocatorScreenshotOptions

Properties

animations?: "disabled" | "allow"

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.

caret?: "hide" | "initial"

When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".

mask?: Locator[]

Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box #FF00FF that completely covers its bounding box.

omitBackground?: boolean

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

path?: string

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?: number

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

scale?: "css" | "device"

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".

timeout?: number

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.

type?: "png" | "jpeg"

Specify screenshot type, defaults to png.

Generated using TypeDoc