Interface: BackgroundManager

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:21

画布背景 manager。

职责域:背景的纯色 / 双色垂直渐变 / 图片(URL、HTMLImageElement、 ImageBitmap、Blob)/ 透明四种形态,以及整体不透明度。 典型入口:setColor() / setGradient() / setImage() / setTransparent()。 未设置时引擎默认显示浅灰垂直渐变。

Remarks

经 Viewer 实例上的 viewer.background 访问,不要直接构造。

Methods

clear()

clear(): void

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:67

清除背景设置(当前等价于 setTransparent())。

Returns

void

---

setColor()

setColor(color): void

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:28

设置纯色背景。

Parameters

color

Color

Returns

void

---

setGradient()

setGradient(top, bottom): void

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:34

设置上下双色垂直渐变背景。

Parameters

top

Color

bottom

Color

Returns

void

---

setImage()

setImage(src, opts?): Promise<void>

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:44

设置图片背景。src 支持 URL 字符串 / URL / HTMLImageElement / ImageBitmap / Blob;opts.fit 控制适配方式(默认 "cover"), opts.opacity 控制不透明度(默认 1)。加载失败抛 ViewerError(NetworkFailed)。

Parameters

src

BackgroundImageSource

opts?

fit?

BackgroundFit

opacity?

number

Returns

Promise<void>

---

setOpacity()

setOpacity(alpha): void

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:55

设置背景整体不透明度(0–1)。

Parameters

alpha

number

Returns

void

---

setTransparent()

setTransparent(): void

Defined in: packages/viewer-core/src/public/managers/BackgroundManager.ts:61

设为透明背景(透出宿主页面)。

Returns

void