Karin API Docs / ScreenshotOptions

接口: ScreenshotOptions

定义于: packages/core/src/adapter/render/admin/types.ts:32

继承于

• screenshot

属性

captureBeyondViewport?

optional captureBeyondViewport: boolean

定义于: packages/core/src/adapter/render/admin/types.ts:84

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

默认值

false 如果没有 clip 的情况下为 false。否则为 true。

---

clip?

optional clip: ScreenshotClip

定义于: packages/core/src/adapter/render/admin/types.ts:72

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

---

encoding?

optional encoding: "base64" | "binary"

定义于: packages/core/src/adapter/render/admin/types.ts:78

图像的编码方式。

已被弃用

这是无效选项，强制性返回base64编码的字符串

---

fromSurface?

optional fromSurface: boolean

定义于: packages/core/src/adapter/render/admin/types.ts:50

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

默认值

true

---

fullPage?

optional fullPage: boolean

定义于: packages/core/src/adapter/render/admin/types.ts:56

当设置为 true 时，将捕获整个页面的屏幕截图。

默认值

false

---

omitBackground?

optional omitBackground: boolean

定义于: packages/core/src/adapter/render/admin/types.ts:62

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

默认值

false

---

optimizeForSpeed?

optional optimizeForSpeed: boolean

定义于: packages/core/src/adapter/render/admin/types.ts:36

默认值

false

---

path?

optional path: string

定义于: packages/core/src/adapter/render/admin/types.ts:68

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

---

quality?

optional quality: number

定义于: packages/core/src/adapter/render/admin/types.ts:44

图像的质量，范围为 0-100。不适用于 png 图像。

---

type?

optional type: "png" | "jpeg" | "webp"

定义于: packages/core/src/adapter/render/admin/types.ts:40

默认值

'png'