Class

2026-01-16


ZegoCreateFileConfig	ZegoCreateWhiteboardConfig
ZegoSuperBoardApiCalledCallbackModel	ZegoSuperBoardCursorAttribute
ZegoSuperboardCustomH5Config	ZegoSuperBoardInitConfig
ZegoSuperBoardManager	ZegoSuperBoardQueryListCallbackModel
ZegoSuperBoardSubView	ZegoSuperBoardSubViewModel
ZegoSuperBoardView	ZegoSuperBoardViewCreatedCallbackModel

ZegoCreateFileConfig

详情

接口参数构造类，用传入创建文件所需要的参数。

业务场景：在调用[createFileView]接口时需要传入。

属性

fileID

fileID: string

文件对应的ID

是否必填：必填

支持版本：2.0.0及以上

ZegoCreateWhiteboardConfig

详情

接口参数构造类，用传入创建白板所需要的参数。

业务场景：在调用 createWhiteboardView 接口是需要传入。

属性

name

name: string

创建白板时需要设置的白板名称。

是否必填：必填
取值范围：限制长度为 128 字节，支持中英文。

支持版本：2.0.0及以上

perPageWidth

perPageWidth: number

每页白板的宽度。

是否必填：必填
取值范围：大于 0 的正整数。

支持版本：v2.0.0。

perPageHeight

perPageHeight: number

每页白板的高度。

是否必填：必填
取值范围：大于0 的正整数。

支持版本：2.0.0及以上

pageCount

pageCount: number

总页数。

是否必填：必填。
取值范围：大于0。

支持版本：2.0.0及以上

ZegoSuperBoardApiCalledCallbackModel

详情

在调用 ZegoSuperBoardManager、ZegoSuperBoardSubView 部分接口后会通过通用回调接口的方式回调此次接口的调用结果。

业务场景：调用 ZegoSuperBoardManager、ZegoSuperBoardSubView 接口后判断此次接口调用是否成功。

属性

errorCode

errorCode: ZegoSuperBoardError

错误码，0表示成功

ZegoSuperBoardCursorAttribute

详情

接口参数构造类，用传入光标样式所需要的参数。

业务场景：在调用[setCustomCursorAttribute:cursorAttribute:complete:]接口时需要传入。

属性

iconPath

iconPath: string

自定义光标图片路径, 本地路径或者网络路径均可（网络图片仅支持 https，图片格式只支持png。）例："xxxxxxxxxx.png"，""

是否必填：否
默认值：

支持版本：v2.4.0

offsetX

offsetX: number

自定义光标作用点，绘制点作用在图片指定x偏移方向，默认为0，不可超出图片宽度

是否必填：否
默认值：0

支持版本：v2.4.0

offsetY

offsetY: number

自定义光标作用点，绘制点作用在图片指定y偏移方向,默认为0，不可超出图片高度

是否必填：否
默认值：0

支持版本：v2.4.0

titleStyle

titleStyle: ZegoSuperBoardCursorTitleStyle

光标自定义文字信息

是否必填：否
默认值：参考ZegoSuperBoardCursorTitleStyle类

支持版本：v2.4.0

ZegoSuperBoardInitConfig

详情

接口参数构造类，用构造初始化SDK所需要的参数。

业务场景：调用初始化SDK接口 initWithConfig 时需要传入。

属性

appID

appID: number

ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台申请。

是否必填：必填
取值范围：0 - 4294967295。

token

token: string

登录验证 token，是通过在即构控制台注册项目获得密钥，加上指定算法获得。测试阶段可以通过 ZEGO 提供的接口获取，正式环境一定要用户自己实现。

userID

userID: string

用户ID，请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

appSign

appSign: string

取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。2.3.0及以上版本 appSign 允许传空或者不传。如果传空或者不传，可以传token进行初始化。token的生成方式请参考使用 Token 鉴权。

cacheFolder

cacheFolder: string

缓存目录

logFolder

logFolder: string

日志目录

ZegoSuperBoardManager

详情

接口类，SDK的初始化，房间内全局性的功能设置, 创建文件或者纯白板等。

业务场景：主要用于初始化SDK，设置白板的一些工具、缩放同步、画笔效果，在开启SuperBoardView模式下,获取SuperBoardView, 创建纯白板、文件等。
平台差异：无。

属性

enableCustomCursor

enableCustomCursor: boolean

设置是否启用自定义光标，设置为 true 则显示光标。默认为true

业务场景：涂鸦过程中显示光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

enableRemoteCursorVisible

enableRemoteCursorVisible: boolean

设置是否是否显示远端光标，设置为 true 则显示远端的光标。默认为true。

业务场景：涂鸦过程中显示远端光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

superBoardMaxScaleFactor

superBoardMaxScaleFactor: ~

调用时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

forceReload

forceReload: boolean

设置是否强制刷新

业务场景：在在部分 iOS 移动设备上渲染文件异常时，执行该 API 进行重新加载文件的操作。
是否必填：是。

reloadType

reloadType: reloadType

该配置，可以针对释放 canvas 的范围进行配置

是否必填：是。

方法

setSuperBoardMaxScaleFactor

setSuperBoardMaxScaleFactor(scaleFactor: Float): void

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

参数

名称	类型	描述
scaleFactor	Float	详情描述：超级白板（文件和白板）最大缩放倍数

详情

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

调用时机/通知时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

支持版本：2.3.7

clearLog

clearLog(): Promise<{ code: number }>

将本地缓存日志上传并清除

将本地缓存日志上传并清除。

支持版本：2.4.0。

操作结果

enableCustomCursor

enableCustomCursor(enable: boolean): void

设置是否开启本端自定义光标

参数

名称	类型	描述
enable	boolean	是否开启

详情

设置白板涂鸦是否使用自定义光标，设置为 true 则光标可设置自定义图片。

是否必填：是。
调用时机：初始化 SDK 之后。

enableRemoteCursorVisible

enableRemoteCursorVisible(enable: boolean): void

设置是否开启显示远端自定义光标

参数

名称	类型	描述
enable	boolean	是否开启

是否必填：是。
调用时机：初始化 SDK 之后。

getInstance

getInstance(): ZegoSuperBoardManager

获取 ZegoSuperBoardManager 实例对象。

获取 ZegoSuperBoardManager 实例对象才能调用 ZegoSuperBoardManager 中的接口方法。

调用时机：集成 ZegoSuperBoard SDK之后，初始化 ZegoSuperBoard SDK 之前。

ZegoSuperBoardManager 实例对象

getSuperBoardSubViewModelList

getSuperBoardSubViewModelList(): List<ZegoSuperBoardSubViewModel>

获取SDK保存的superBoardSubView的信息

通过superBoardSubViewModelList,可以获取到当前房间内存在的superBoardSubView的数量以及superBoardSubView的信息。

业务场景：进房后需要获取房间内的superBoardSubView列表做展示，在列表中切换当前展示的superBoardSubView。
调用时机/通知时机：初始化 ZegoSuperboard SDK 之后。

SDK保存的superBoardSubView的信息

isEnabledCustomCursor

isEnabledCustomCursor(): boolean

是否开启光标显示

光标是否开启

调用时机：初始化 SDK 之后。

光标是否开启

isEnabledResponseScale

isEnabledResponseScale(): boolean

获取当前是否会响应别的用户同步过来的缩放系数

获取当前是否会响应别的用户同步过来的缩放系数。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

当前是否会响应别的用户同步过来的缩放系数

isEnabledSyncScale

isEnabledSyncScale(): boolean

获取当前是否会同步缩放系数给别的用户

获取当前是否会同步缩放系数给别的用户。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

当前是否会同步缩放系数给别的用户

isEnabledRemoteCursorVisible

isEnabledRemoteCursorVisible(): boolean

远端光标是否开启

是否必填：是。
调用时机：初始化 SDK 之后。

远端光标是否开启

setContainerView

setContainerView(): Promise<void>

需要挂载文件白板区域

将需要挂载文件白板区域传入 SDK。

调用时机：初始化 SDK后，成功登录房间之后

setCustomCursorAttribute

  setCustomCursorAttribute(type: ZegoSuperBoardTool, attr: ZegoSuperBoardCursorAttribute): Promise<ZegoSuperBoardApiCalledCallbackModel>

自定义设置本端自定义光标

参数

名称	类型	描述
type	ZegoSuperBoardTool	设置工具类型，目前仅支持设置画笔样式
attr	ZegoSuperBoardCursorAttribute	自定义光标相关属性

详情

设置本端自定义光标的指针图标和指针的热点(即自定义图标的实际点击位置)

是否必填：是。
调用时机：开启本端自定义光标之后。

setLogConfig

setLogConfig(config: ZegoLogConfig): boolean

日志高级配置

参数

名称	类型	描述
config	ZegoLogConfig	日志配置选项

详情

配置客户端打印日志级别，日志是定位问题的重要手段。

业务场景：在多数场景下，客户不用调用该接口，使用默认配置即可。
默认值：本地日志为 error。
调用时机：在初始化之后，其他任何接口之前调用。

支持版本：2.1.6
使用限制：无，但建议整个生命周期内只调用一次。
注意事项：除非有明确的特殊需求，否则请勿调用该接口更改默认配置。

返回值

调用是否成功; 失败情况: 输入参数格式有误

uploadFile

uploadFile(filePath: string, renderType: ZegoSuperBoardRenderType): Promise<void>

上传文件到 ZegoSuperBoard 服务

参数

名称	类型	描述
filePath	string	需要上传的文件绝对路径，支持 ppt、pdf、xls、jpg、jpeg、png、bmp、txt 等类型的文件，具体参考文件规范。
renderType	ZegoSuperBoardRenderType	上传文件转码后的渲染模式类型，建议设置为 VectorAndIMG，详见 ZegoSuperBoardRenderType。

详情

上传过程中，SDK 会根据传入的 [renderType] 对文件进行格式转换，格式转换后文件的渲染模式取决于传入的 [renderType]，可在结果回调中获取上传的进度信息。

业务场景：上传文件到 ZegoDocs 服务。
调用时机：初始化 ZegoSuperBoard SDK 之后。

注意事项：上传阶段会有多次回调，详细请查阅 ZegoSuperBoardUploadFileState 定义

返回值

返回上传文件的请求 seq

cancelUploadFile

cancelUploadFile(seq: number): Promise<ZegoSuperBoardApiCalledCallbackModel>

在上传文件的过程中取消上传动作

参数

名称	类型	描述
seq	number	调用uploadFile时返回的上传seq。

详情

执行取消上传文件的操作必须传入对应的上传任务的seq。

业务场景：在上传文件的过程中需要中断对应文件的上传到ZegoDocs service。
调用时机：调用uploadFile接口后正在上传文件过程中的时候调用。

cacheFile

cacheFile(fileID: string): Promise<ZegoSuperBoardApiCalledCallbackModel>

将文件缓存到本地

参数

名称	类型	描述
fileID	string	需要缓存的文件 ID

详情

可以把对应文件保存到本地。

业务场景：把文件保存到本地，下次打开不需要请求网络，提升打开速度。
调用时机：需要在 initWithConfig 之后调用。

返回值

操作结果

cancelCacheFile

cancelCacheFile(seq: ZegoSuperBoardSeq): boolean

在缓存文件的过程中取消缓存动作

参数

名称	类型	描述
seq	ZegoSuperBoardSeq	缓存操作的序列号。

详情

可以取消掉正在缓存文件的操作，需要传入对应缓存文件操作的seq，取消后文件不会被缓存到本地。

业务场景：在执行缓存文件过程中，需要中断当前缓存文件的操作，可以调用cancelCacheFile方法来取消掉对应的操作。
调用时机：需要在 initWithConfig 之后调用。
相关接口：cacheFile。

支持版本：2.0.0 及以上。

返回值

操作结果

queryFileCached

queryFileCached(fileID: string): Promise<ZegoSuperBoardQueryCachedModel>

查询文件缓存是否存在

参数

名称	类型	描述
fileID	string	待查询的文件ID。

详情

通过对应文件的ID可以查找到该文件是否本地已经缓存下来了。

业务场景：查询文件缓存是否存在。
调用时机：需要在 initWithConfig 之后调用。
相关接口：cacheFile。

uploadH5File

uploadH5File(filePath: string, config: ZegoSuperboardCustomH5Config): Promise<void>

上传自定义H5课件

参数

名称	类型	描述
filePath	string	自定义课件的本地路径
config	ZegoSuperboardCustomH5Config	自定义H5课件相关配置信息

详情

上传过程中，SDK 会根据传入的 [config] 对文件进行格式转换，格式转换后文件的宽高页码以及是否带缩略图取决于传入的 [config]，可在结果回调中获取上传的进度信息。

业务场景：上传自定义H5课件。
调用时机：您需要在初始化成功后调用它。

返回值

返回上传文件信息

setCustomFontFromAsset

setCustomFontFromAsset(regularAssetPath: string, boldAssetPath: string): void

设置自定义新字体

参数

名称	类型	描述
regularAssetPath	string	常规字体的字体名称，请联系技术支持获取
boldAssetPath	string	粗体字体的字体名称，请联系技术支持获取

详情

需要给白板中的文本工具设置新的自定义字体样式。

业务场景：设置自定义新字体。
调用时机：需要在创建纯白板或者文件白板完成之后调用。

注意事项：只支持特定的字体, 并且需要在工程中内置我们提供的字体文件，请联系技术支持获取字体文件与对应的字体名。

init

init(config: ZegoSuperBoardInitConfig): Promise<ZegoSuperBoardApiCalledCallbackModel>

初始化 ZegoSuperBoard SDK

参数

名称	类型	描述
config	ZegoSuperBoardInitConfig	SDK 初始化所需要的配置信息

详情

初始化ZegoSuperBoard SDK的方法。

业务场景：初始化 ZegoSuperBoard SDK。
调用时机：在调用ZegoExpressEngine SDK的loginRoom接口前。
相关接口：unInit。

返回值

初始化的结果回调

setCustomizedConfig

setCustomizedConfig(key: ZegoSuperBoardCustomConfigKey, value: string): Promise<void>

设置配置项<br/>例如：<br/>key值为 logPath，SDK记录日志的目录地址。<br/>key值为 cachePath，SDK缓存的目录地址。

参数

名称	类型	描述
key	ZegoSuperBoardCustomConfigKey	value 描述
value	string	key 描述

调用时机：初始化 Superboard SDK 后调用

返回值

设置是否成功

enableSuperBoardView

enableSuperBoardView(enable: boolean): Promise<void>

设置是否使用 SuperBoardView

参数

名称	类型	描述
enable	boolean	true 代表使用 SuperBoardView, false 代表不使用, 默认为 true.

详情

设置是否使用 SuperBoardView。

调用时机：初始化 SDK 之前。

注意事项：默认开启

createWhiteboardView

createWhiteboardView(config: ZegoCreateWhiteboardConfig): Promise<ZegoSuperBoardViewCreatedCallbackModel>

创建纯白板

参数

名称	类型	描述
config	ZegoCreateWhiteboardConfig	纯白板相关的配置参数

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建纯白板的时候。

createFileView

createFileView(config: ZegoCreateFileConfig): Promise<ZegoSuperBoardViewCreatedCallbackModel>

创建文件

参数

名称	类型	描述
config	ZegoCreateFileConfig	创建文件需要的配置参数

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建文件的时候。

destroySuperBoardSubView

destroySuperBoardSubView(uniqueID: string): Promise<ZegoSuperBoardApiCalledCallbackModel>

销毁指定的 SuperBoardSubView 视图

参数

名称	类型	描述
uniqueID	string	ZegoSuperBoardSubView 对象的唯一标识

调用时机：在调用 querySuperBoardSubViewList 拉取到列表后或者 superBoardSubViewModelList 获取到 model 数量大于 0 的时候调用。

注意事项：如需批量删除，请串行执行

querySuperBoardSubViewList

querySuperBoardSubViewList(): Promise<ZegoSuperBoardQueryListCallbackModel>

向服务器查询当前存在的 SuperBoardSubView 列表

将当前房间内的白板一次性拉取下来，SDK内部会将关联了文件的白板中的文件也加载下来，这些白板和文件SDK内部会处理对应关系添加到ZegoSuperBoardSubView中，外部只需要使用ZegoSuperBoardView即可。

调用时机：初始化SDK，登录房间之后调用。

clearCache

clearCache(): Promise<void>

清除文件和白板相关的缓存资源

调用时机：初始化，进入房间之后，SDK 对于房间内资源的清理，需要在退出房间前主动调用。

clear

clear(): void

清空房间内资源退房时调用

退房时需要清空房间内的缓存信息，以及停止媒体播放。

调用时机：需要在退房前主动调用。

unInit

unInit(): void

反初始化SDK

调用时机：当你需要重新初始化SDK时，你必须先调用unInit。

支持版本：2.0.0及以上

getSDKVersion

getSDKVersion(): string

获取SDK的版本号

获取 SDK 版本号。

业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

调用时机：在任意时刻均可调用。

支持版本：v2.0.0 及以上。

SDK的版本号

getCustomizedConfig

getCustomizedConfig(key: ZegoSuperBoardCustomConfigKey): Promise<string>

获取设置的配置项的值

参数

名称	类型	描述
key	ZegoSuperBoardCustomConfigKey	要获取的设置项

详情

获取设置的配置项的值。

调用时机：初始化 Superboard SDK，调用 setCustomizedConfig 之后。

on

on(event: K, callBack: ZegoEvent[K]): void

注册监听事件

参数

名称	类型	描述
event	K	监听事件名
callBack	ZegoEvent[K]	回调函数

业务场景：可通过注册指定方法获取相关信息，例如注册切换白板通知事件，即可监听对端实时切换白板的 UniqueID。
调用时机：初始化 ZegoSuperBoard SDK 之后。

返回值

注册是否成功

off

off<K extends keyof ZegoEvent>(event: K, listener?: ZegoEvent[K]): void

删除监听事件

参数

名称	类型	描述
event	K	需要解除监听事件名称
listener?	ZegoEvent[K]	回调函数

详情

可删除指定监听事件。

调用时机：初始化 ZegoSuperboard SDK 且注册了监听事件后。

返回值

解除是否成功

getSuperBoardView

getSuperBoardView(): ZegoSuperBoardView

获取 SuperBoardView 对象

开了 SuperBoardView 模式，获取该对象。

业务场景：在开启 SuperBoardView 模式下，使用该对象上的方法进行 A 端切换白板，B 端自动同步。
默认值：默认获得该对象。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0及以上。
注意事项：如果使用 enableSuperBoardView 接口并设置为 false ，则无法获取 SuperBoardView 对象。

BoardView 对象

enableSyncScale

enableSyncScale(enable: boolean): void

设置是否将缩放同步给房间内其他成员

参数

名称	类型	描述
enable	boolean

详情

开启之后，可以将本端缩放的发送出去，对端是否要接受，需要对端开启接受缩放。

业务场景：使操作端和接受端的白板缩放同步。
默认值：未调用此接口设置场景时，默认的配置为 false。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableResponseScale

enableResponseScale(): Promise<boolean>

是否响应房间内其他成员的缩放

开启之后，可以响应房间内其他成员的缩放，前提是对端将缩放同步给房间内其他成员。

业务场景：使操作端和接受端的白板缩放同步。
默认值：未调用此接口设置场景时，默认的配置为 false。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableHandwriting

enableHandwriting(enable: boolean): Promise<boolean>

设置是否开启笔锋

参数

名称	类型	描述
enable	boolean	是否开启笔锋

详情

设置白板涂鸦是否拥有笔锋效果，设置为 true 则该涂鸦带有笔锋效果。

业务场景：根据涂鸦绘制过程中的速度调整笔画粗细和形状，增强书写体验。
默认值：false。
调用时机/通知时机：初始化 SDK 之后。

支持版本：2.0.0及以上。

isEnabledHandwriting

isEnabledHandwriting(): Promise<boolean>

获取是否开启笔锋效果

当前使用工具类型为画笔时，调用 isHandwritingEnabled 可获得是否开启笔锋效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

是否开启笔锋效果

setToolType

setToolType(tool: ZegoSuperBoardTool): Promise<void>

设置白板工具类型

参数

名称	类型	描述
tool	ZegoSuperBoardTool	白板工具。

详情

设置工具类型，使鼠标拥有不同的功能效果。

默认值：默认值 1，默认工具为画笔
调用时机：初始化 ZegSuperBoard SDK 之后。

支持版本：2.0.0及以上。

getToolType

getToolType(): Promise<ZegoSuperBoardTool>

获取正在使用的白板工具类型。

获取正在使用的白板工具类型

调用时机：初始化 ZegoSuperBoard SDK之后。

支持版本：2.0.0及以上。

如果有则返回使用中的工具类型，否则返回 null

setFontBold

setFontBold(bold: boolean): Promise<void>

设置文本粗体

参数

名称	类型	描述
bold	boolean	是否设置文字粗体

详情

选择了文字工具类型，调用 setFontBold 设置为 true之后，在白板上新增的文字都是粗体效果。

默认值：false
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置文本粗体之后新增的文字拥有粗体效果，如之前白板上已存在文字不会更改为粗体效果。

返回值

设置结果

isFontBold

isFontBold(): Promise<boolean>

获取文本是否为粗体

当前使用工具类型为文本时，调用 isFontBold 可获得是否设置粗体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

是否是粗体效果

setFontItalic

setFontItalic(italic: boolean): Promise<void>

设置文本工具的文本是否斜体。

参数

名称	类型	描述
italic	boolean

详情

设置文本工具的文本是否斜体。

默认值：false
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅调用之后新增的文字生效，如之前白板上已存在文字不会更改。

返回值

设置结果

isFontItalic

isFontItalic(): Promise<boolean>

获取文字是否为斜体效果

当前使用工具类型为文本时，调用 isFontItalic 可获得是否设置斜体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

返回是否设置斜体

setFontSize

setFontSize(fontSize: number): Promise<void>

设置文本大小

参数

名称	类型	描述
fontSize	number	字体大小

详情

选择了文字工具类型，调用 setFontSize 设置，在白板上新增的文字都是设置之后的大小。

默认值：24，最大值不得超过 100
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅调用 setFontSize 之后新增的文字生效，如之前白板上已存在文字不会更改为字体大小。

返回值

设置结果

getFontSize

getFontSize(): Promise<number

获取文本大小

当前使用工具类型为文本时，调用 getFontSize 可获得当前文本工具的字体大小。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

字体大小

setBrushSize

setBrushSize(size: number): Promise<void>

设置画笔粗细

参数

名称	类型	描述
size	number	画笔粗细

详情

选择了画笔工具类型，调用 setBrushSize 设置数值，在白板上新增的涂鸦粗细即设置的值。

默认值：6
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置画笔粗细之后新增的涂鸦拥有新的粗细效果，如之前白板上已存在涂鸦不会更改为粗细。

返回值

设置结果

getBrushSize

getBrushSize(): Promise<number>

获取画笔粗细

当前使用工具类型为文本时，调用 getBrushSize 可获得画笔粗细。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

画笔粗细

setBrushColor

setBrushColor(color: string): Promise<void>

设置画笔颜色

参数

名称	类型	描述
color	string	颜色

详情

选择了画笔工具类型，调用 setBrushColor 之后，白板上新增的涂鸦颜色生效。

默认值：#f54326
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置画笔颜色之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改为颜色。

返回值

设置结果

getBrushColor

getBrushColor(): Promise<string>

获取画笔颜色

当前使用工具类型为画笔时，调用 getBrushColor 可获得当前画笔颜色。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

画笔颜色，16 进制 RGBA

ZegoSuperBoardQueryListCallbackModel

详情

数据模型类，里面包含了创建的ZegoSuperboardSubView的名称、创建时间、包含的文件ID、文件类型以及ZegoSuperboardSubView 对象的唯一标识。

业务场景：主要用户获取对应ZegoSuperboardSubView对象的名称和文件信息。

属性

errorCode

errorCode: ZegoSuperBoardError

subViewModelList

subViewModelList: ZegoSuperBoardSubViewModel[]

extraInfo

extraInfo: string

ZegoSuperBoardSubView

方法

clearSelected

clearSelected(): void

删除选中图元

批量删除选中多个图元

调用时机：当白板上存在图元即可使用。

支持版本：2.0.0及以上

getCurrentStep

getCurrentStep(): number

获取动态 PPT 当前页码的动画步骤，从1开始

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
使用限制：仅动态 PPT 才可调用

当前页码的动画步骤

reloadView

reloadView(options?: ReloadOptions): void

重新加载 SubView

参数

名称	类型	描述
options	ReloadOptions	重载配置项

详情

动态修改挂载父容器大小时可以使用该方法重新加载 SubView

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
使用限制：1. 每次调用该接口，整个 SubView 内容会重新绘制，位置会实时自适应。会为了提高交互体验，可限频调用。

仅支持浏览器缩放为 100% 时调用此 API 重新加载 View，否则可能会因为此 API 的自适应策略与浏览次缩放导致的自适应策略冲突导致文件显示异常。

getExcelSheetNameList

getExcelSheetNameList(): Promise<string[]>

获取 Excel 的 Sheet 名字列表

获取这个excel文件的所有sheet表的名字。

业务场景：需要展示excel文件的sheet表的时候，通过这个方法获取这个excel文件的所有sheet表的名字。
调用时机：createFile 成功之后或者拉取列表成功。

注意事项：对于非excel的文件类型返回一个空的列表。

Excel 文件的 Sheet 名字列表

getThumbnailUrlList

getThumbnailUrlList(): Promise<string[]>

获取当前文件的缩略图列表，仅支持 PDF 、PPT、动态 PPT 、H5文件格式

如果需要展示文件的预览画面，可以通过这个接口来获取对应的预览图片，然后通过点击预览图片进行翻页。

业务场景：展示文件每一页的预览画面。
调用时机：在文件加载后调用，否则返回一个空列表。

使用限制：仅支持 PDF 、PPT、动态 PPT 、H5文件格式,其他类型返回一个空的列表。

文件每一页的缩略图的URL地址列表

getPPTNotes

getPPTNotes(page: number): Promise<string>

获取 PPT 指定页码的备注

参数

名称	类型	描述
page	number	指定的页码，从1开始

详情

获取 PPT 指定页码的备注。

业务场景：获取 PPT 指定页码的备注。
调用时机：loadFile 成功之后。

使用限制：仅支持PPT、动态 PPT 文件格式,其他类型返回null。

返回值

该页备注，若没有备注，则返回空字符串

getCurrentSuperBoardSubViewModel

getCurrentSuperBoardSubViewModel(): ZegoSuperBoardSubViewModel

获取白板对应的model数据

获取白板对应的 ZegoSuperBoardSubViewModel 数据。

业务场景：获取白板对应的 ZegoSuperBoardSubViewModel 数据，比如白板ID、名字、关联的文件ID、当前的缩放系数等。
调用时机：初始化 ZegoSuperBoard SDK 之后。

白板对应的 ZegoSuperBoardSubViewModel 数据

inputText

inputText(): Promise<ZegoSuperBoardApiCalledCallbackModel>

给白板 View 添加文本,调用后会从白板底部弹出输入框。

业务场景：给白板 View 添加文本,调用后会从白板底部弹出输入框。
默认值：输入框的默认内容是 "文本" ，可以通过 [ZegoSuperBoardManager.setCustomText] 设置默认文本，默认显示位置是当前白板范围的中间
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

undo

undo(): Promise<void>

撤销白板的上一步操作

撤销白板的上一步操作。

业务场景：白板的相关操作。
相关接口：redo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

redo

redo(): Promise<void>

恢复白板上一步撤销的操作

恢复白板上一步撤销的操作。

业务场景：白板的相关操作。
相关接口：undo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

clearCurrentPage

clearCurrentPage(): Promise<ZegoSuperBoardApiCalledCallbackModel>

清除白板当前页的图元

清除白板当前页的图元。

业务场景：白板相关操作。
相关接口：clearAllPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

操作结果回调。如果删除当前页的图元成功，则会返回成功，否则失败

clearAllPage

clearAllPage(): void

清除白板所有页的图元

清除白板所有页的图元。

业务场景：白板相关操作。
相关接口：clearCurrentPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上

setOperationMode

setOperationMode(mode: ZegoSuperBoardOperationMode): Promise<void>

设置当前白板的操作模式

参数

名称	类型	描述
mode	ZegoSuperBoardOperationMode	操作模式

详情

设置当前白板的操作模式，比如禁止客户端对白板的手势操作。用户可使用按位或的方式同时设置多种模式，比如设置为 Zoom | Draw 时，可同时支持放缩模式和绘制模式。

业务场景：设置toolType的时候，需要调用这个方法来对白板进行处理。如果需要禁止客户端对白板的手势操作，可以使用这个方法设置成None模式。如果要滚动文件，则设置成滚动模式，其他的白板工具，则设置成绘制模式
默认值：绘制/缩放模式。
影响范围：设置为滚动模式的时候，此时手势会被识别为滚动，设置为绘制模式的时候，此时手势会被识别为绘制相关的操作。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：只有当 currentSuperBoardSubView 存在时才可调用，可通过 getCurrentSuperBoardSubView() 方法进行判断 currentSuperBoardSubView 是否存在，否则不会有任何效果。

flipToPage

flipToPage(targetPage: number): Promise<ZegoSuperBoardApiCalledCallbackModel>

跳转到指定页面

参数

名称	类型	描述
targetPage	number	目标页的页码，从1开始

详情

跳转到指定页面。

业务场景：指定一个页码进行跳转。
相关回调：scrollChange。
相关接口：flipToPrePage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToPrePage

flipToPrePage(): Promise<ZegoSuperBoardApiCalledCallbackModel>

跳转到上一页

跳转到上一页。

相关回调：scrollChange。
相关接口：flipToPage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToNextPage

flipToNextPage(): Promise<ZegoSuperBoardApiCalledCallbackModel>

跳转到下一页

跳转到下一页。

相关回调：scrollChange。
相关接口：flipToPage，flipToPrePage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

preStep

preStep(): Promise<ZegoSuperBoardApiCalledCallbackModel>

跳转到上一步动画

跳转到上一步动画。

相关接口：nextStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

nextStep

nextStep(): Promise<ZegoSuperBoardApiCalledCallbackModel>

跳转到下一步动画

跳转到下一步动画。

相关接口：preStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

getPageCount

getPageCount(): Promise<number>

获取总页码数

获取总页码数。

调用时机：使用ZegoSuperBoardView时，当 currentSuperBoardSubView 存在的时候即可调用。不使用ZegoSuperBoardView时，当 superBoardSubViewModelList 存在superBoardSubViewModel的时候即可调用。

支持版本：2.0.0及以上。

总页码数

switchSuperBoardSubViewWithSheetIndex

  switchSuperBoardSubViewWithSheetIndex(uniqueID: string, sheetIndex: number): Promise<ZegoSuperBoardApiCalledCallbackModel>

切换excel文件到指定sheet页

参数

名称	类型	描述
uniqueID	string	excel 文件目标sheet表的 index
sheetIndex	number	excel文件目标sheet表的index

详情

切换excel文件到指定sheet页。

默认值：打开excel文件的时候，默认是在第 0 个sheet页。
调用时机：当currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.3.6 及以上。

getVisibleSize

getVisibleSize(): ZegoSuperboardSize

获取可见区域的大小

获取文件可见区域的大小，比如用1000x1000的大小去加载一张64x64的图片，此时可见区域的大小是64x64。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果不是文件白板，会返回0。

可见区域的大小

getCurrentSheetName

getCurrentSheetName(): Promise<string>

获取当前展示的sheet名称

获取当前展示的sheet名称,如果不是excel，则返回null。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

当前展示的sheet名称

addImage

  addImage(type : ZegoSuperBoardViewImageType, address: string, positionX: number, positionY: number): Promise<ZegoSuperBoardApiCalledCallbackModel>

插入图片到白板

参数

名称	类型	描述
type	ZegoSuperBoardViewImageType	图片类型，目前支持普通图片和自定义图形
address	string	图片地址，支持本地图片地址和网络图片地址，本地图片会先上传到cdn存储。目前自定义图形只支持网络图片地址。（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
positionX	number	图片插入位置的起始点，相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
positionY	number	图片插入位置的起始点，相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。

详情

插入图片到白板显示或者设置自定义图形。

业务场景：设置自定义图形后，在选择白板工具为自定义图形时，触摸白板会绘制此处传入的自定义图形
相关回调：IZegoSuperBoardApiCalledCallback。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：支持的图片类型：png/jpg/jpeg，当type为Graphic时，支持本地图片和网络图片，图片大小限制10M，当type为Custom时，只支持网络图片，图片大小限制500KB。

clearSelected

clearSelected(): Promise<ZegoSuperBoardApiCalledCallbackModel>

删除选中的图元

通过白板的选择工具选择一些图元，调用这个方法可以删除选中的图元。

调用时机：获取到SuperBoardSubView列表之后。

setBackgroundImage

  setBackgroundImage(address: string, mode: ZegoSuperBoardViewImageFitMode): Promise<ZegoSuperBoardApiCalledCallbackModel>

向白板设置背景图

参数

名称	类型	描述
address	string	背景图片路径, 本地路径或者网络路径均可（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
mode	ZegoSuperBoardViewImageFitMode	背景图片填充模式

详情

向白板设置背景图，支持本地路径或者网络路径，这个背景图会同步给房间内的其他用户。

调用时机：获取到SuperBoardSubView列表之后。

clearBackgroundImage

clearBackgroundImage(): Promise<ZegoSuperBoardApiCalledCallbackModel>

清除白板的背景图

清除白板的背景图，这个动作会同步给房间内的其他用户。

调用时机：获取到SuperBoardSubView列表之后。

stopPlayPPTVideo

stopPlayPPTVideo(): Promise<void>

停止当前动态ppt页面正在播放的视频

停止当前动态ppt页面正在播放的视频,一般用于切换文件时，停止掉动态 PPT 文件的音视频播放。

调用时机：在文件加载成功之后,播放音视频的过程中调用。

setWhiteboardBackgroundColor

setWhiteboardBackgroundColor(color: string): Promise<void>

设置白板的背景颜色

参数

名称	类型	描述
color	string	背景颜色

详情

设置白板的背景颜色,比如纯白板设置成灰色等。

默认值：rgb(241, 243, 244)
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：1. 因白板是覆盖在文件上方，设置白板背景颜色会遮挡文件。2. 设置白板背景色之后，房间内全部白板背景色均会生效

返回值

设置结果

ZegoSuperBoardSubViewModel

详情

数据模型类，里面包含了创建的ZegoSuperBoardSubView的名称、创建时间、包含的文件ID、文件类型以及ZegoSuperBoardSubView 对象的唯一标识。

业务场景：用户获取对应ZegoSuperBoardSubView对象的ID，名称和文件信息。

属性

name

name: string

SuperBoardSubView 对应的名称

createTime

createTime: number

白板创建时间 Unix 时间戳(毫秒)

fileID

fileID: string

创建文件白板时使用的文件ID，此 ID 唯一

fileType

fileType: ZegoSuperBoardFileType

创建文件白板时使用的文件类型，详见ZegoSuperBoardFileType

uniqueID

uniqueID: string

SuperBoardSubview的ID，此ID唯一。

whiteboardIDList

whiteboardIDList: string[]

白板ID的列表

ZegoSuperBoardView

方法

getCurrentSuperBoardSubView

getCurrentSuperBoardSubView(): ZegoSuperBoardSubView | null

获取当前展示 superBoardSubView

业务场景：如需对当前展示的 superBoardSubView 进行翻页操作等，获取当前展示 superBoardSubView之后调用 superBoardSubView 上的翻页方法。
调用时机：初始化 ZegoSuperBoard SDK 之后。

注意事项：在开启 superBoardView 模式下生效

当前展示 superBoardSubView

switchSuperBoardSubView

switchSuperBoardSubView(uniqueID: string, sheetIndex?: number): Promise<ZegoSuperBoardApiCalledCallbackModel>

切换到指定的SuperBoardSubView

参数

名称	类型	描述
uniqueID	string	SuperBoardSubView的唯一标识
sheetIndex?	number	如切换 BoardSubView 是 Excel 文件，需要操作切换指定 Sheet 可传入 sheetIndex

详情

切换到指定SubView，多端同步。

相关回调：remoteSuperBoardSubViewSwitched。

ZegoSuperBoardViewCreatedCallbackModel

创建SubView的完成回调

详情

调用 createWhiteboardView、createFileView 接口后, 创建后的结果通过此回调出来。

业务场景：创建白板、文件。

回调时机：调用 createWhiteboardView、createFileView 接口。

相关接口： [createWhiteboardView]、[createFileView]

支持版本：0.1.0及以上。

属性

errorCode

errorCode: number

错误码，0表示成功

name

name: string

SuperBoardSubView 对应的名称

createTime

createTime: number

白板创建时间 Unix 时间戳(毫秒)

fileID

fileID: string

创建文件白板时使用的文件ID，此 ID 唯一

fileType

fileType: number

创建文件白板时使用的文件类型，详见ZegoSuperBoardFileType

uniqueID

uniqueID: string

SuperBoardSubview 的 ID，此ID唯一。

whiteboardIDList

whiteboardIDList: string[]

白板 ID 的列表

ZegoSuperboardCustomH5Config

详情

自定义H5课件属性构造类，可以设置自定义课件的宽、高、页数以及缩略图信息。

业务场景：在上传自定义H5课件接口中需要传入。

属性

width

width: number

是否必填：必填
取值范围：大于0

height

height: number

是否必填：必填
取值范围：大于0

pageCount

pageCount: number

是否必填：必填
取值范围：大于0

thumbnailList

thumbnailList: string[]

支持版本：0.1.0及以上