SdkOptions interface 参考

详细描述Copy Anchor Link

适用版本：@shengwang/whiteboard 0.2.11。

buildSdkOptions(options) 的返回结构；函数从包入口导出，SdkOptions 类型名本身未从 @shengwang/whiteboard 包入口单独导出。业务可直接接收函数返回值，不要 import { SdkOptions }。

export interface SdkOptions {
  dynamicConfig?: DynamicConfigOptions;
  appIdentifier: string;
  log: boolean;
  useMultiViews?: boolean;
  userCursor?: boolean;
  disableNewPencilStroke: boolean;
  enableAppliancePlugin?: boolean;
  presentationAppOptions?: PresentationAppOptions;
  slideAppOptions?: SlideAppOptions;
  loggerOptions?: LoggerOptions;
  backgroundImageLoadOptions?: BackgroundImageLoadOptions;
}

变量说明Copy Anchor Link

dynamicConfigCopy Anchor Link

dynamicConfig?: DynamicConfigOptions;

可选的 region → 当前平台配置 JSON URL 映射；由 WhiteboardOptions 原样传入。

appIdentifierCopy Anchor Link

appIdentifier: string;

必填。来自 WhiteboardOptions.appIdentifier 的白板项目 AppIdentifier。

logCopy Anchor Link

log: boolean;

必填布尔值。当前 buildSdkOptions 固定为 true。

useMultiViewsCopy Anchor Link

useMultiViews?: boolean;

可选多窗口开关。未显式提供时保留 undefined；显式 false 仍是本地覆盖，不等同于未提供。

userCursorCopy Anchor Link

userCursor?: boolean;

可选用户光标开关。未显式提供时保留 undefined，允许动态配置参与。

disableNewPencilStrokeCopy Anchor Link

disableNewPencilStroke: boolean;

必填布尔值。当前 buildSdkOptions 固定为 false。

enableAppliancePluginCopy Anchor Link

enableAppliancePlugin?: boolean;

可选教具插件开关。未显式提供时保留 undefined；本地显式值优先。

presentationAppOptionsCopy Anchor Link

presentationAppOptions?: PresentationAppOptions;

可选的内置 Presentation 课件配置，来自同名宿主选项。

slideAppOptionsCopy Anchor Link

slideAppOptions?: SlideAppOptions;

可选的动态 PPT 配置，来自同名宿主选项。

loggerOptionsCopy Anchor Link

loggerOptions?: LoggerOptions;

可选日志配置。宿主提供 localLogOptions 时映射为 { localLog: localLogOptions }；未提供时为 undefined。

backgroundImageLoadOptionsCopy Anchor Link

backgroundImageLoadOptions?: BackgroundImageLoadOptions;

可选的背景图加载配置，来自宿主同名选项。