Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Returns the buffer with the captured screenshot from the browser.
Parameter
Type
Default
Description
options
object
null
options.clip
object
null
An object which specifies clipping of the resulting image.
options.clip.x
number
0
x-coordinate of top-left corner of clip area.
options.clip.y
number
0
y-coordinate of top-left corner of clip area.
options.clip.width
number
0
Width of clipping area.
options.clip.height
number
0
Height of clipping area.
options.fullPage
boolean
false
When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport.
options.omitBackground
boolean
false
Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.
options.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.
options.quality
number
0
The quality of the image, between 0-100; Only applicable to jpeg only.
options.type
string
png
Specify screenshot type. Acceptable values are jpeg and png.