# WhiteboardOptions interface 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## 详细描述 [#详细描述] 适用版本:**@shengwang/whiteboard 0.2.11**。 Whiteboard 组件的初始化和入房配置。 可从 @shengwang/whiteboard 直接导入 WhiteboardOptions。仅用于类型声明,不能作为构造函数调用 new。 ## 类型结构(源码声明) [#类型结构源码声明] 下方源码文件的 export 声明不等同于 SDK 包入口导出;业务导入方式以上方说明为准。 ```text export interface WhiteboardOptions ``` | [appIdentifier](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a7b547e0a83aa78727145570ea2a28562) | `appIdentifier: string` | | --- | --- | | [userCursor](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#afce9a1bf6a819634d02255d9aeb65a3d) | `userCursor?: boolean` | | [userPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a35ff0922721e1e934863953d1e802488) | `userPayload?: object` | | [useMultiViews](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a823ed4d5e21cbbe46f02b1af1b86fd83) | `useMultiViews?: boolean` | | [enableAppliancePlugin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a6c63f7ef79888957639ae2ec90dc8cf2) | `enableAppliancePlugin?: boolean` | | [appliancePluginOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a311a1a1f745dedd2e62070c97064cd92) | `appliancePluginOptions?: AppliancePluginOptions` | | [presentationAppOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#ad85b7bacdfeee92ee5e8b173f0badb6c) | `presentationAppOptions?: PresentationAppOptions` | | [slideAppOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a69ad23ba442140f6e8d72e4eda11e194) | `slideAppOptions?: SlideAppOptions` | | [localLogOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a717d25d287a95d4cdb63f949464d347c) | `localLogOptions?: LocalLogOptions` | | [windowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a0e373bb897eec26d640ec2a01ca3328c) | `windowParams?: WindowParams` | | [roomUuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a0b82e4e287cf718c0bff1fab50077897) | `roomUuid: string` | | [roomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#abeca6f6d94dbf15a7c6d0f2be40bdd34) | `roomToken: string` | | [uid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#abe34b0d0138188000f0805f5e6d16620) | `uid: string` | | [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a28ef84ef7fe84e7926df63d7c22eadff) | `region: Region` | | [writable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a57429b2e02277397cbdff6f817244f96) | `writable?: boolean` | | [disableCameraTransform](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a61626ef22ca7ad1ac13e0af176fbacf3) | `disableCameraTransform?: boolean` | | [disableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a7c8f000b3c8f71fd22bcadc375a88439) | `disableDeviceInputs?: boolean` | | [disableOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a491cfcc6666bc0852a6c3b0bcbddf219) | `disableOperations?: boolean` | | [floatBar](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#a149295d3eb5109c99a624194747d36ee) | `floatBar?: boolean` | | [timeout](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#ae5cd02d91424298f6791be660408aa50) | `timeout?: number` | | [undoCacheScenesCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#afb77b009bc85fee09c80f5bcd25f6662) | `undoCacheScenesCount?: number` | | [callbacks](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#ac25df374a6290f7bf1085c9735865059) | `callbacks?: WhiteboardCallbacks` | | [backgroundImageLoadOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#ac9984c531e1d6a48b3adbae90b28b842) | `backgroundImageLoadOptions?: BackgroundImageLoadOptions` | | [dynamicConfig](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-whiteboard-options#ad0613761cc01c03e91be599774c50458) | `dynamicConfig?: DynamicConfigOptions` | ## 变量说明 [#变量说明] ### appIdentifier [#appidentifier] ```text appIdentifier: string ``` 类型成员,必填性和返回类型以声明为准。 ### userCursor [#usercursor] ```text userCursor?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### userPayload [#userpayload] ```text userPayload?: object ``` 类型成员,必填性和返回类型以声明为准。 ### useMultiViews [#usemultiviews] ```text useMultiViews?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### enableAppliancePlugin [#enableapplianceplugin] ```text enableAppliancePlugin?: boolean ``` 启用内嵌高性能绘制插件,默认 false;无需单独安装 npm 插件,同房间各端应一致开启。 ### appliancePluginOptions [#appliancepluginoptions] ```text appliancePluginOptions?: AppliancePluginOptions ``` 本地绘制插件参数,extras 为配置嵌套层;与启用开关配合使用。 ### presentationAppOptions [#presentationappoptions] ```text presentationAppOptions?: PresentationAppOptions ``` 本地内置 Presentation 配置,初始化 SDK 前传入。 ### slideAppOptions [#slideappoptions] ```text slideAppOptions?: SlideAppOptions ``` 类型成员,必填性和返回类型以声明为准。 ### localLogOptions [#locallogoptions] ```text localLogOptions?: LocalLogOptions ``` 本地日志配置;显式开启 enabled 才生效,enabledUpload 只控制上传。 ### windowParams [#windowparams] ```text windowParams?: WindowParams ``` 类型成员,必填性和返回类型以声明为准。 ### roomUuid [#roomuuid] ```text roomUuid: string ``` 类型成员,必填性和返回类型以声明为准。 ### roomToken [#roomtoken] ```text roomToken: string ``` 类型成员,必填性和返回类型以声明为准。 ### uid [#uid] ```text uid: string ``` 类型成员,必填性和返回类型以声明为准。 ### region [#region] ```text region: Region ``` 类型成员,必填性和返回类型以声明为准。 ### writable [#writable] ```text writable?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### disableCameraTransform [#disablecameratransform] ```text disableCameraTransform?: boolean ``` 禁止设备输入引发的视角变化;不会禁止程序调用支持的视角接口。 ### disableDeviceInputs [#disabledeviceinputs] ```text disableDeviceInputs?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### disableOperations [#disableoperations] ```text disableOperations?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### floatBar [#floatbar] ```text floatBar?: boolean ``` 类型成员,必填性和返回类型以声明为准。 ### timeout [#timeout] ```text timeout?: number ``` 类型成员,必填性和返回类型以声明为准。 ### undoCacheScenesCount [#undocachescenescount] ```text undoCacheScenesCount?: number ``` 撤销/重做保留的场景缓存数量;在入房前配置,未设置时交由内嵌 Web SDK 决定。 ### callbacks [#callbacks] ```text callbacks?: WhiteboardCallbacks ``` 类型成员,必填性和返回类型以声明为准。 ### backgroundImageLoadOptions [#backgroundimageloadoptions] ```text backgroundImageLoadOptions?: BackgroundImageLoadOptions ``` 背景图片加载重试和超时配置,见 BackgroundImageLoadOptions。 ## 公开变量 [#公开变量] ### dynamicConfig [#dynamicconfig] ```text dynamicConfig?: DynamicConfigOptions ``` region → 当前平台配置 URL 映射。未映射 region 或读取失败使用本地参数。不要传配置平台网页地址;详见动态配置接入文档。