Puppeteer 中文文档v25.8.0

ScreenshotOptions 接口

签名

export interface ScreenshotOptions

属性

属性

修饰符

类型

说明

默认值

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

number

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

type

optional

ImageFormat

'png'