# HasBackgroundImageParams interface 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-has-background-image-params)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**@shengwang/whiteboard 0.2.11**。

controller.hasBackgroundImage(...) 的匹配参数。

可从 @shengwang/whiteboard 直接导入 HasBackgroundImageParams。仅用于类型声明，不能作为构造函数调用 new。

## 类型结构（源码声明） [#类型结构源码声明]

下方源码文件的 export 声明不等同于 SDK 包入口导出；业务导入方式以上方说明为准。

```text
export interface HasBackgroundImageParams
```

| [viewId](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-has-background-image-params#a04fc7bbcd230357fcb49daa2827ab19e) | `viewId: string` |
| --- | --- |
| [scenePath](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-has-background-image-params#a7211c3c187f815c3e30f105b643d1085) | `scenePath: string` |
| [imageUrl](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-has-background-image-params#a6beb6052ace98d678dc07156404b2d4f) | `imageUrl: string` |
| [sources](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-has-background-image-params#a501cd9c3eb6a964ef759d80fc7a0ea42) | `sources: BackgroundImageSource[]` |

## 变量说明 [#变量说明]

<a id="a04fc7bbcd230357fcb49daa2827ab19e"></a>

### viewId [#viewid]

```text
viewId: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a7211c3c187f815c3e30f105b643d1085"></a>

### scenePath [#scenepath]

```text
scenePath: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a6beb6052ace98d678dc07156404b2d4f"></a>

### imageUrl [#imageurl]

```text
imageUrl: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a501cd9c3eb6a964ef759d80fc7a0ea42"></a>

### sources [#sources]

```text
sources: BackgroundImageSource[]
```

需要匹配的背景图来源列表，当前填写 ["appliance"]。