Package com.microsoft.playwright

Class Page.ScreenshotOptions

  • Enclosing interface:
    Page
    public static class Page.ScreenshotOptions
extends Object

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

      • 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 to false.

      • 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 by maskColor) 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 to jpeg images. Defaults to false.

      • 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 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 to png 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".

      • type

        public ScreenshotType type
        Specify screenshot type, defaults to png.

    • Constructor Detail

      • ScreenshotOptions

        public ScreenshotOptions()

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

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

      • setFullPage

        public Page.ScreenshotOptions setFullPage​(boolean fullPage)
        When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to false.

      • 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 by maskColor) that completely covers its bounding box.

      • setOmitBackground

        public Page.ScreenshotOptions setOmitBackground​(boolean omitBackground)
        Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

      • setPath

        public Page.ScreenshotOptions setPath​(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 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 to png 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".