Skip to content

VM Code SDK v2 / PageScreenshotOptions

Type alias: PageScreenshotOptions ​

PageScreenshotOptions: object & SelectorScreenshotOptions

Type declaration ​

clip? ​

optional clip: object

An object which specifies clipping of the resulting image. Should have the following fields:

clip.height ​

height: number

height of clipping area

clip.width ​

width: number

width of clipping area

clip.x ​

x: number

x-coordinate of top-left corner of clip area

clip.y ​

y: number

y-coordinate of top-left corner of clip area

fullPage? ​

optional fullPage: boolean

When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to false.