# BackgroundImageLoadEvent interface 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event)

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

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

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

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

背景图加载结果事件数据。

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

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

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

```text
export interface BackgroundImageLoadEvent
```

| [name](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#af014ca3d904037bf85e8db499e532499) | `name: 'backgroundImageLoad'` |
| --- | --- |
| [state](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#ad04f409298550055d6a953d33af4f15f) | `state: 'success' \| 'failed' \| 'cancelled'` |
| [source](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#a30dc78a77a7f9fde8d2354f1ff872418) | `source: BackgroundImageSource` |
| [resourceId](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#a8665308d14fe57fd99d8d291c91ee26c) | `resourceId: string` |
| [resourceUrl](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#adbfe4f1a4466fdbadb906b8dbd9ed63d) | `resourceUrl: string` |
| [viewId](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#a76601ebd929ae16e12404a0e33f08582) | `viewId: string` |
| [scenePath](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-background-image-load-event#a7999b40c0fe3dd2035e0b60f09c0b833) | `scenePath: string` |

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

<a id="af014ca3d904037bf85e8db499e532499"></a>

### name [#name]

```text
name: 'backgroundImageLoad'
```

事件名为 backgroundImageLoad。

<a id="ad04f409298550055d6a953d33af4f15f"></a>

### state [#state]

```text
state: 'success' | 'failed' | 'cancelled'
```

背景图加载结果：success、failed 或 cancelled。

<a id="a30dc78a77a7f9fde8d2354f1ff872418"></a>

### source [#source]

```text
source: BackgroundImageSource
```

背景图来源：appliance，表示 Appliance Plugin 管理的背景图。

<a id="a8665308d14fe57fd99d8d291c91ee26c"></a>

### resourceId [#resourceid]

```text
resourceId: string
```

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

<a id="adbfe4f1a4466fdbadb906b8dbd9ed63d"></a>

### resourceUrl [#resourceurl]

```text
resourceUrl: string
```

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

<a id="a76601ebd929ae16e12404a0e33f08582"></a>

### viewId [#viewid]

```text
viewId: string
```

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

<a id="a7999b40c0fe3dd2035e0b60f09c0b833"></a>

### scenePath [#scenepath]

```text
scenePath: string
```

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