跳到主要内容
版本: 23.11.1

ScreenshotOptions 接口

签名

export interface ScreenshotOptions

属性

属性

修饰符

类型

描述

默认值

captureBeyondViewport

可选

boolean

捕获视口之外的屏幕截图。

如果没有 clip,则为 false。否则为 true

clip

可选

ScreenshotClip

指定要裁剪的页面/元素区域。

encoding

可选

'base64' | 'binary'

图像的编码。

'binary'

fromSurface

可选

boolean

从表面而不是视图捕获屏幕截图。

true

fullPage

可选

boolean

当为 true 时,截取整个页面的屏幕截图。

false

omitBackground

可选

boolean

隐藏默认的白色背景,并允许捕获具有透明度的屏幕截图。

false

optimizeForSpeed

可选

boolean

false

path

可选

string

保存图像的文件路径。屏幕截图类型将从文件扩展名推断。如果路径是相对路径,则它是相对于当前工作目录解析的。如果未提供路径,则图像不会保存到磁盘。

quality

可选

number

图像质量,介于 0-100 之间。不适用于 png 图像。

type

可选

'png' | 'jpeg' | 'webp'

'png'