Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the screenshot options.

Hierarchy

Index

Properties

Optional clip

An object which specifies clipping region of the page.

Optional encoding

encoding: "base64" | "binary"

The encoding of the image, can be either base64 or binary.

default

binary

Optional fullPage

fullPage: boolean

When true, takes a screenshot of the full scrollable page.

default

false

Optional omitBackground

omitBackground: boolean

Hides default white background and allows capturing screenshots with transparency.

default

false

Optional path

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 current working directory. If no path is provided, the image won't be saved to the disk.

Optional quality

quality: number

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

Optional type

type: "jpeg" | "png"

The screenshot type.

default

png