Karin API Docs / Options

接口: Options

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

截图参数

继承

• screenshot

属性

captureBeyondViewport?

optional captureBeyondViewport: boolean

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

捕获视口之外的屏幕截图

默认值

false

继承自

screenshot.captureBeyondViewport

---

clip?

optional clip: ScreenshotClip

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

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

继承自

screenshot.clip

---

data?

optional data: Record<string, any>

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

传递给 art-template 的参数

---

encoding?

optional encoding: "base64" | "binary"

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

图像的编码方式。

已被弃用

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

继承自

screenshot.encoding

---

file

file: string

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

http地址或本地文件路径

继承自

screenshot.file

---

fromSurface?

optional fromSurface: boolean

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

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

默认值

true

继承自

screenshot.fromSurface

---

fullPage?

optional fullPage: boolean

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

截图整个页面

默认值

false

继承自

screenshot.fullPage

---

headers?

optional headers: Record<string, string>

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

• 额外的 HTTP 头信息将随页面发起的每个请求一起发送
• 标头值必须是字符串
• 所有 HTTP 标头名称均小写。(HTTP 标头不区分大小写，因此这不会影响服务器代码）。

继承自

screenshot.headers

---

multiPage?

optional multiPage: number | boolean

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

分页截图 传递数字则视为视窗高度 返回数组

继承自

screenshot.multiPage

---

name?

optional name: string

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

保存文件目录 推荐使用插件名称

---

omitBackground?

optional omitBackground: boolean

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

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

默认值

false

继承自

screenshot.omitBackground

---

optimizeForSpeed?

optional optimizeForSpeed: boolean

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

控制截图的优化速度

默认值

false

继承自

screenshot.optimizeForSpeed

---

pageGotoParams?

optional pageGotoParams: GoToOptions

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

页面goto时的参数

继承自

screenshot.pageGotoParams

---

path?

optional path: string

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

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

继承自

screenshot.path

---

quality?

optional quality: number

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

截图质量 默认90

默认值

90

继承自

screenshot.quality

---

selector?

optional selector: string

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

选择的元素截图 fullPage为false时生效 如果未找到指定元素则使用body

默认值

'body'

继承自

screenshot.selector

---

setViewport?

optional setViewport: object

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

设置视窗大小和设备像素比

deviceScaleFactor?

optional deviceScaleFactor: number

设备像素比

默认值

1

height?

optional height: number

视窗高度

width?

optional width: number

视窗宽度

继承自

screenshot.setViewport

---

type?

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

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

截图类型

默认值

'jpeg'

继承自

screenshot.type

---

waitForFunction?

optional waitForFunction: string | string[]

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

等待特定函数完成

继承自

screenshot.waitForFunction

---

waitForRequest?

optional waitForRequest: string | string[]

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

等待特定请求完成

继承自

screenshot.waitForRequest

---

waitForResponse?

optional waitForResponse: string | string[]

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

等待特定响应完成

继承自

screenshot.waitForResponse

---

waitForSelector?

optional waitForSelector: string | string[]

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

等待指定元素加载完成

继承自

screenshot.waitForSelector