ScreenshotOptions
Constructor
Section titled “Constructor”Constructor
Section titled “Constructor”new ScreenshotOptions():
ScreenshotOptions
Returns
Section titled “Returns”ScreenshotOptions
Properties
Section titled “Properties”antialias?
Section titled “antialias?”
optionalantialias?:boolean
Whether the image should be anti-aliased Defaults to false
compression?
Section titled “compression?”
optionalcompression?:number
Compression factor for JPEG, images between 0.0 and 1.0. Defaults to 1.0
height?
Section titled “height?”
optionalheight?:number
The height of the image in pixels, must be > 0 Defaults to the height of the viewport
renderOptions?
Section titled “renderOptions?”
optionalrenderOptions?:object
Additional rendering options for the screenshot each of the following options defaults to ‘false’.
NOTE: This is not available with the Ruby version of the JSA backend.
| Name | Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SDK 2.30.1, Protocol 1.25.2
scaleFactor?
Section titled “scaleFactor?”
optionalscaleFactor?:number
Scaling factor for elements that are viewport dependent, such as text heights, arrow heads, line widths, stipple patterns, etc. Defaults to 1.0
transparent?
Section titled “transparent?”
optionaltransparent?:boolean
Whether the image should have transparency Defaults to false
width?
Section titled “width?”
optionalwidth?:number
The width of the image in pixels, must be > 0 Defaults to the width of the viewport