Skip to main content
Version: 23.8.0

ScreenshotOptions 接口

¥ScreenshotOptions interface

签名

¥Signature

export interface ScreenshotOptions

属性

¥Properties

属性

修饰符

类型

描述

默认

captureBeyondViewport

optional

boolean

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

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

clip

optional

ScreenshotClip

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

encoding

optional

'base64' | 'binary'

图片的编码。

'binary'

fromSurface

optional

boolean

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

true

fullPage

optional

boolean

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

false

omitBackground

optional

boolean

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

false

optimizeForSpeed

optional

boolean

false

path

optional

string

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

quality

optional

数字

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

type

optional

'png' | 'jpeg' | 'webp'

'png'