Skip to main content
Version: Next

ScreenshotOptions interface


export interface ScreenshotOptions


captureBeyondViewport?boolean(Optional) Capture the screenshot beyond the viewport.true
clip?ScreenshotClip(Optional) An object which specifies the clipping region of the page.
encoding?'base64' | 'binary'(Optional) Encoding of the image.binary
fromSurface?boolean(Optional) Capture the screenshot from the surface, rather than the view.true
fullPage?boolean(Optional) When true, takes a screenshot of the full page.false
omitBackground?boolean(Optional) Hides default white background and allows capturing screenshots with transparency.false
path?string(Optional) 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.
quality?number(Optional) Quality of the image, between 0-100. Not applicable to png images.
type?'png' | 'jpeg' | 'webp'(Optional)png