跳至主要內容
版本:23.11.1

ScreenshotOptions 介面

簽名

export interface ScreenshotOptions

屬性

屬性

修飾符

類型

描述

預設值

captureBeyondViewport

選填

布林值

擷取視窗外區域的螢幕截圖。

如果沒有 clip,則為 false。否則為 true

clip

選填

ScreenshotClip

指定要剪裁的頁面/元素區域。

encoding

選填

'base64' | 'binary'

圖片編碼。

'binary'

fromSurface

選填

布林值

從表面而不是視圖擷取螢幕截圖。

true

fullPage

選填

布林值

當為 true 時,會擷取完整頁面的螢幕截圖。

false

omitBackground

選填

布林值

隱藏預設的白色背景,並允許擷取具有透明度的螢幕截圖。

false

optimizeForSpeed

選填

布林值

false

path

選填

字串

儲存圖片的檔案路徑。螢幕截圖類型將會從檔案副檔名推斷。如果路徑是相對路徑,則會以目前的工作目錄為基準解析。如果未提供路徑,則不會將圖片儲存到磁碟。

quality

選填

數字

圖片品質,介於 0-100 之間。不適用於 png 圖片。

type

選填

'png' | 'jpeg' | 'webp'

'png'