ApplianceCursorOptions interface 参考

详细描述Copy Anchor Link

适用版本：@shengwang/whiteboard 0.2.11。

光标配置，通过 WhiteboardOptions.appliancePluginOptions.extras.cursor 使用。

当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。

类型结构（源码声明）Copy Anchor Link

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

export interface ApplianceCursorOptions

配置示例Copy Anchor Link

通过已导出的 AppliancePluginExtrasOptions 描述外层配置；cursor.enable 与 cursor.expirationTime 在本版引用结构中必填。

import { AppliancePluginExtrasOptions } from '@shengwang/whiteboard';

const extras: AppliancePluginExtrasOptions = {
  cursor: { enable: true, expirationTime: 3000 }
};

将 extras 放入 WhiteboardOptions.appliancePluginOptions.extras，并设置 enableAppliancePlugin=true。无需单独导入 ApplianceCursorOptions。

变量说明Copy Anchor Link

enableCopy Anchor Link

enable: boolean

Appliance Plugin 的同步光标开关；与 WhiteboardOptions.userCursor 分属不同配置项。

expirationTimeCopy Anchor Link

expirationTime: number

同步光标最后一次更新后的保留时间，单位毫秒；到期后隐藏。提供 cursor 对象时，该字段在本版 ArkTS 类型中必填。

syncedLabelCopy Anchor Link

syncedLabel?: ApplianceCursorSyncedLabelOptions

同步光标标签的全局显示配置。

appearanceCopy Anchor Link

appearance?: ApplianceCursorAppearanceMap

按教具配置光标外观；本版 ArkTS 结构提供 pencil 和 clicker。