Class

2026-01-16


ZegoLoadOption	ZegoSuperBoardManager
ZegoSuperBoardSubView	ZegoSuperBoardSubViewImpl
ZegoSuperBoardView

ZegoLoadOption

预览文件加载配置项

详情

设置加载动态文件回调方法触发时机。通常情况下从文件服务器获得加载文件的信息后马上触发回调。

业务场景：获取加载动态 PPT 文件准备就绪状态

属性

PPTReady

PPTReady: boolean

获取加载动态 PPT 文件是否准备就绪状态

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之后失效。

方法

setSuperBoardMaxScaleFactor

setSuperBoardMaxScaleFactor(scaleFactor: Float): void

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

参数

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

详情

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

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

支持版本：2.3.7

renewToken

renewToken(token?: string): void

更新Token

参数

名称	类型	描述
token	string	需要更新的 Token。

详情

token 权限变更、或者 token 过期时调用，用于更新 token 权限

默认值：无
调用时机：初始化 SDK 后，借助 ZEGO SDK 的将要过期回调 [tokenWillExpire] 接口，收到 token 将要过期回调，主动更新超级白板的文件服务 token。
影响范围：token 内包含的过期时间，在过期前 30s 会触发 [tokenWillExpire] 回调
相关回调：无
相关接口：[tokenWillExpire]
平台差异：无

clearLog

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

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

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

支持版本：2.4.0。

操作结果

createPreviewFileView

createPreviewFileView(fileID: string, parentDomID: string): Promise<ZegoSuperPreviewView>

创建一个用于预览指定文件的视图

参数

名称	类型	描述
fileID	string	想要预览的文件 ID。
parentDomID	string	挂载元素的 ID。

详情

用户传入文件 ID 和 parentID 后，创建一个用于预览指定文件的视图。该视图可以用来显示文件的内容，并返回该视图对象。

业务场景：超级白板初始化后，客户不需要进入房间就能在指定区域创建一个预览视图以便用户查看文件内容。
调用时机：超级白板初始化后

支持版本：2.19.0 版本及以上

返回值

返回一个 ZegoSuperPreviewView 对象。

destroyAllSuperBoardSubView

destroyAllSuperBoardSubView(): Promise<boolean>

销毁所有 SuperBoardSubView 视图

销毁所有的 SuperBoardSubView 视图。

业务场景：需要一次性销毁所有白板视图时调用。
默认值：无。
调用时机：初始化SDK，登录房间之后调用。
相关回调：remoteSuperBoardSubViewRemoved。

支持版本：2.20.0及以上版本。
使用限制：按需调用一次。
注意事项：异步调用，返回Promise<boolean>。

销毁所有视图是否成功

enableCustomCursor

enableCustomCursor(enable: boolean): void

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

参数

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

详情

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

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

支持版本：2.2.0及以上。

enableRemoteCursorVisible

enableRemoteCursorVisible(enable: boolean): void

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

参数

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

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

支持版本：2.2.0及以上。

getCurrentPreview

getCurrentPreview(): ZegoSuperPreviewView

获取当前预览文件视图

获取当前预览文件视图对象。

业务场景：用于获取当前界面上正在预览的文件内容。
调用时机/通知时机：调用 createPreviewFileView 后。

支持版本：2.19.0

当前预览文件视图对象。

getInstance

getInstance(): ZegoSuperBoardManager

获取 ZegoSuperBoardManager 实例对象。

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

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

支持版本：2.0.0 及以上。

ZegoSuperBoardManager 实例对象

getPreviewList

getPreviewList(): ZegoSuperPreviewView[]

获取预览文件列表

想要获取所有预览文件视图时，可通过方法获取一个含有所有已创建的 ZegoSuperPreviewView 的数组。

业务场景：获取预览文件列表。
调用时机：调用 [createPreviewFileView] 方法后。

支持版本：2.19.0

一个包含所有 ZegoSuperPreviewView 的数组

getWhiteboardBackgroundColor

getWhiteboardBackgroundColor(): string

获取白板背景色

调用 getWhiteboardBackgroundColor 可获得白板背景颜色。

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

支持版本：支持版本：2.0.0及以上。

白板背景色，16 进制或者 RGBA

setCustomCursorAttribute

setCustomCursorAttribute(type: ZegoSuperBoardTool, attr: ZegoCursorAttribute): Promise<any>

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

参数

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

详情

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

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

支持版本：2.2.0及以上。
注意事项：设置指针的热点位置，建议两个小于32的无单位非负数。

setLogConfig

setLogConfig(config: ZegoLogConfig): boolean

日志高级配置

参数

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

详情

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

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

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

返回值

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

switchPreview

switchPreview(preview: ZegoSuperPreviewView): void

切换当前预览文件视图

参数

名称	类型	描述
preview	ZegoSuperPreviewView	想要切换到的预览视图。

详情

切换到指定的预览文件视图。

业务场景：在用户想要预览其他文件时。
调用时机：初始化超级白板sdk后

支持版本：2.19.0

uploadFile

  uploadFile(file: File, renderType: ZegoSuperBoardRenderType, listener: ZegoSuperBoardUploadCallback, uploadOptions?: uploadOptions): Promise<string>

上传文件到 ZegoSuperBoard 服务

参数

名称	类型	描述
file	File	待上传的文件对象，支持 ppt、pdf、xls、jpg、jpeg、png、bmp、txt 等类型的文件，具体参考文件规范。
renderType	ZegoSuperBoardRenderType	上传文件转码后的渲染模式类型，建议设置为 VectorAndIMG，详见 ZegoSuperBoardRenderType。
listener	ZegoSuperBoardUploadCallback	上传的进度和结果的回调。上传文件的过程中，会在 [listener] 内收到多次回调，具体请查看 ZegoSuperBoardUploadModel 的介绍
uploadOptions	uploadOptions	上传文件配置项

详情

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

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

支持版本：2.0.0 及以上。
注意事项：上传阶段会有多次回调，详细请查阅 ZegoSuperBoardUploadFileState 定义

返回值

返回转码完成的文件 ID

cancelUploadFile

cancelUploadFile(fileHash: string): Promise<boolean>

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

参数

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

详情

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

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

支持版本：2.0.0 及以上。

返回值

操作结果

cacheFile

  cacheFile(fileID: string, listener?: ZegoSuperBoardCacheFileCallBack): Promise<ZegoSuperBoardDynamicCacheModel | ZegoSuperBoardStaticCacheModel>

提前请求文件资源

参数

名称	类型	描述
fileID	string	需要提前请求资源的文件 ID
listener?	ZegoSuperBoardCacheFileCallBack	缓存文件进度和结果回调。只有加载静态类型文件，才会触发缓存进度回调。加载动态文件，并不会触发缓存进度回调。

详情

可以预先请求对应文件的资源。

业务场景：可优化在同一浏览器、同一域名下，打开文件的速度。
调用时机：在加载文件之前使用。

支持版本：2.0.0 及以上。
使用限制：1. 该接口的实现依赖于浏览器的缓存策略，因此缓存只在同一个浏览器、同一个域名下生效。前两者发生变更则需要重新缓存。

受限于浏览器缓存策略，在隐身模式、域名不安全状态下，缓存可能无效。
当用户强制刷新页面，旧缓存可能会被清除掉，或者禁用浏览器缓存的时候，该缓存也不会生效。

注意事项：该 API 在 2.0.0 及以上版本仅对动态文件有效，2.6.0 及以上版本对全文件类型有效

返回值

预先请求文件资源情况

cancelCacheFile

cancelCacheFile(seq: number): boolean

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

参数

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

详情

可以取消掉正在缓存文件的操作，需要传入对应缓存文件操作的seq。

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

支持版本：2.6.0 及以上。
注意事项：该 API 仅对预加载文件类型为静态文件时有效

返回值

操作结果

uploadH5File

  uploadH5File(filePath: string, config: ZegoUploadCustomH5Config, listener: ZegoSuperBoardUploadH5FileCallback): Promise<string>

上传自定义H5课件

参数

名称	类型	描述
filePath	string	待上传的文件对象
config	ZegoUploadCustomH5Config	自定义H5课件相关配置信息
listener	ZegoSuperBoardUploadH5FileCallback	上传的进度的回调。上传文件的过程中，会在 [listener] 内收到多次回调，具体请查看 uploadH5FileCallBack 的介绍。

详情

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

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

支持版本：2.0.0 及以上。

返回值

返回上传文件ID

init

init(zegoWebRTC: any, config: ZegoSuperBoardInitConfig): Promise<boolean>

初始化 ZegoSuperBoard SDK

参数

名称	类型	描述
zegoWebRTC	any	Express-Video SDK 的实例
config	ZegoSuperBoardInitConfig	SDK 初始化所需要的配置信息

详情

初始化 ZegoSuperBoard SDK 的方法。

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

支持版本：2.0.0 及以上。
注意事项：请初始化 ZegoSuperBoard SDK 成功之后再调用 loginRoom 方法

返回值

初始化的结果回调

setCustomizedConfig

setCustomizedConfig(key: ZegoSuperboardCustomConfigKey, value: string): boolean

设置配置项

参数

名称	类型	描述
key	ZegoSuperboardCustomConfigKey	配置项
value	string	配置项的值

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

支持版本：2.0.0 及以上。

返回值

设置是否成功

enableSuperBoardView

enableSuperBoardView(enable: boolean): void

设置是否使用 SuperBoardView

参数

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

详情

设置是否使用 SuperBoardView。

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

支持版本：2.0.0 及以上。
注意事项：默认开启

createWhiteboardView

createWhiteboardView(config: ZegoCreateWhiteboardConfig): Promise<ZegoSuperBoardSubViewModel>

创建纯白板

参数

名称	类型	描述
config	ZegoCreateWhiteboardConfig	纯白板相关的配置参数。其中 perPageWidth，perPageHeight 必须要正整数，否则会创建失败

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

支持版本：2.0.0 及以上。

返回值

返回该白板的 ZegoSuperBoardSubViewModel

createFileView

createFileView(config: ZegoCreateFileConfig): Promise<ZegoSuperBoardSubViewModel>

创建文件白板

参数

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

详情

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

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

支持版本：2.0.0 及以上。

返回值

返回该文件白板的 ZegoSuperBoardSubViewModel

destroySuperBoardSubView

destroySuperBoardSubView(uniqueID: string|string[]): Promise<void>

销毁指定的 SuperBoardSubView 视图

参数

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

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

支持版本：2.0.0 及以上。
注意事项：如需批量删除，SDK 版本应为 2.20.0 或以上，且在调用本接口时请传入 string[] 类型的 uniqueID

querySuperBoardSubViewList

querySuperBoardSubViewList(): Promise<ZegoSuperBoardSubViewModel[]>

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

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

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

支持版本：2.0.0及以上

SuperBoardSubView 列表

getSuperBoardSubView

getSuperBoardSubView(uniqueID: string): ZegoSuperBoardSubViewImpl | null

获取指定的 SuperBoardSubView

参数

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

调用时机：初始化SDK，进房成功后，获取到SuperBoardSubView列表之后调用。

支持版本：2.0.0及以上
注意事项：仅限于不使用 SuperBoardView （通过 enableSuperBoardView 设置）的场景使用

clearCache

clearCache(): void

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

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

支持版本：2.0.0及以上

unInit

unInit(): void

反初始化SDK

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

支持版本：2.14.0 及以上

getSDKVersion

getSDKVersion(): string

获取SDK的版本号

获取 SDK 版本号。

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

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

SDK的版本号

getCustomizedConfig

getCustomizedConfig(key: ZegoSuperBoardCustomConfigKey): string

获取设置的配置项的值

参数

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

详情

获取设置的配置项的值。

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

支持版本：2.0.0及以上。

返回值

获取设置的配置项的值

on

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

注册监听事件

参数

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

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

支持版本：2.0.0及以上。

返回值

注册是否成功

off

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

删除监听事件

参数

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

详情

可删除指定监听事件。

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

支持版本：2.0.0及以上。

返回值

解除是否成功

getSuperBoardView

getSuperBoardView(): ZegoSuperBoardView

获取 SuperBoardView 对象

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

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

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

BoardView 对象

attachSuperBoardSubView

attachSuperBoardSubView(subView: ZegoSuperBoardSubView, parentDomID: string): Promise<void>

添加 SuperBoardSubView 到视图

参数

名称	类型	描述
subView	ZegoSuperBoardSubView	要挂载的 SuperBoardSubView 对象
parentDomID	string	要挂载点父容器 ID 注意事项：请确保在调用该方法时，父容器 ID 真实存在，宽高的物理像素不为0

详情

在未开启 SuperBoardView 模式下，手动添加 SuperBoardSubView 到视图

调用时机：初始化 ZegoSuperBoard SDK 且调用 enableSuperBoardView 接口设置为 false。
相关回调：操作端添加 SuperBoardSubView 到视图，对端可通过 remoteSuperBoardSubViewAdded 监听获取。

支持版本：2.0.0及以上。
注意事项：添加目标视图的物理像素宽高不得小于 0。

setWhiteboardBackgroundColor

setWhiteboardBackgroundColor(color: string): boolean

设置白板的背景颜色

参数

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

详情

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

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

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

返回值

设置结果

setDeferredRenderingTime

setDeferredRenderingTime(delay: number): void

设置本端 SubView 延时渲染的时间

参数

名称	类型	描述
delay	number	延迟渲染时间，单位毫秒

详情

设置本端 SubView 延时渲染的时间，对端所有 SubView 相关内容同步都会延迟，包括其触发的 ZegoEvent 相关回调事件的执行。

业务场景：如果使用的音视频流是通过 CDN 转推。在房间内，接收端接受音视频流和白板文件流存在一个延迟时间，通过该方法，延迟执行白板相关的同步，即可做到“音画同步”
调用时机：初始化 ZegoSuperboard SDK后。
影响范围：对端所有 SubView 相关内容同步都会延迟，包括其触发的 ZegoEvent 相关回调事件的执行。

支持版本：2.0.0及以上。

enableSyncScale

enableSyncScale(enable: boolean): void

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

参数

名称	类型	描述
enable	boolean

详情

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

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

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

enableResponseScale

enableResponseScale(enable: boolean): void

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

参数

名称	类型	描述
enable	boolean	true 代表响应房间内其他成员的缩放, false 代表不响应, 默认为 false.

详情

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

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

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

enableHandwriting

enableHandwriting(enable: boolean): void

设置是否开启笔锋

参数

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

详情

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

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

支持版本：2.0.0及以上。

isHandwritingEnabled

isHandwritingEnabled(): boolean

获取是否开启笔锋效果

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

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

支持版本：2.0.0及以上。

是否开启笔锋效果

setToolType

setToolType(tool: ZegoSuperBoardTool): boolean

设置白板工具类型

参数

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

详情

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

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

支持版本：2.0.0及以上。

返回值

设置是否成功

getToolType

getToolType(): ZegoWhiteboardTool | null

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

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

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

支持版本：2.0.0及以上。

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

setFontBold

setFontBold(bold: boolean): boolean

设置文本粗体

参数

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

详情

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

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

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

返回值

设置结果

isFontBold

isFontBold(): boolean

获取文本是否为粗体

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

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

支持版本：2.0.0及以上。

是否是粗体效果

setFontItalic

setFontItalic(italic: boolean): boolean

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

参数

名称	类型	描述
italic	boolean

详情

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

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

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

返回值

设置结果

isFontItalic

isFontItalic(): boolean

获取文字是否为斜体效果

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

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

支持版本：2.0.0及以上。

返回是否设置斜体

setFontSize

setFontSize(fontSize: number): boolean

设置文本大小

参数

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

详情

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

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

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

返回值

设置结果

getFontSize

getFontSize(): number

获取文本大小

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

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

支持版本：2.0.0及以上。

字体大小

setBrushSize

setBrushSize(size: number): boolean

设置画笔粗细

参数

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

详情

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

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

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

返回值

设置结果

getBrushSize

getBrushSize(): number

获取画笔粗细

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

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

支持版本：2.0.0及以上。

画笔粗细

setBrushColor

setBrushColor(color: string): boolean

设置画笔颜色

参数

名称	类型	描述
color	string	颜色

详情

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

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

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

返回值

设置结果

getBrushColor

getBrushColor(): string

获取画笔颜色

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

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

支持版本：2.0.0及以上。

画笔颜色，16 进制 RGBA

ZegoSuperBoardSubView

方法

clearSelected

clearSelected(): void

删除选中图元

批量删除选中多个图元

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

支持版本：2.0.0及以上

getCurrentStep

getCurrentStep(): number

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

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

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

当前页码的动画步骤

getScaleFactor

getScaleFactor(): ZegoSuperBoardScaleModel

获取当前 superBoardSubView 的缩放信息

当前 superBoardSubView 进行缩放后，获取当前 superBoardSubView 的缩放相关信息。

调用时机：初始化 ZegoSuperBoard SDK ，对 BoardSubView 进行缩放后。

支持版本：2.0.0 及以上。

当前缩放信息

reloadView

reloadView(options?: ReloadOptions): void

重新加载 SubView

参数

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

详情

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

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

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

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

setScaleFactor

setScaleFactor(scaleFactor: number): void

缩放 superBoardSubView

参数

名称	类型	描述
scaleFactor	number	缩放倍数，不小于 1

详情

对 superBoardSubView 进行缩放。

默认值：1
调用时机：初始化 ZegoSuperBoard SDK 之后。
相关回调：superBoardSubViewScaleChanged 监听远端缩放

支持版本：2.0.0 及以上。
使用限制：设置的缩放系数不得小于 1。当前白板工具类型为点击时，调用缩放接口无效。
注意事项：需要白板已经挂载之后，设置才生效。

getExcelSheetNameList

getExcelSheetNameList(): Promise<string[]>

获取 Excel 的 Sheet 名字列表

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

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

支持版本：2.0.0 及以上。
注意事项：对于非excel的文件类型返回一个空的列表。

Excel 文件的 Sheet 名字列表

getThumbnailUrlList

getThumbnailUrlList(): Promise<string[]>

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

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

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

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

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

getPPTNotes

getPPTNotes(page: number): string

获取 PPT 指定页码的备注

参数

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

详情

获取 PPT 指定页码的备注。

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

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

返回值

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

getModel

getModel(): ZegoSuperBoardSubViewModel

获取白板对应的model数据

获取白板对应的 ZegoSuperBoardSubViewModel 数据。

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

支持版本：2.0.0 及以上。

白板对应的 ZegoSuperBoardSubViewModel 数据

addText

addText(text: string, positionX: number, positionY: number): void

向白板添加自定义文本

参数

名称	类型	描述
text	string	待添加文本图元的字符串内容
positionX	number	相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域
positionY	number	相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域

详情

在白板view中添加文本,可以指定添加的位置。

业务场景：在 SubView 指定位置添加文本，会创建一个新的文本图元。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

undo

undo(): void

撤销白板的上一步操作

撤销白板的上一步操作。

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

支持版本：2.0.0 及以上。

redo

redo(): void

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

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

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

支持版本：2.0.0 及以上。

clearCurrentPage

clearCurrentPage(): void

清除白板当前页的图元

清除白板当前页的图元。

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

支持版本：2.0.0及以上

clearAllPage

clearAllPage(): void

清除白板所有页的图元

清除白板所有页的图元。

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

支持版本：2.0.0及以上。

setOperationMode

setOperationMode(mode: ZegoSuperBoardOperationMode): void

设置当前白板的操作模式

参数

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

详情

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

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

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

snapshot

snapshot(customData?: {userData: string}): Promise<ZegoWhiteboardViewSnapshotModel>

获取当前白板快照

参数

名称	类型	描述
customData?	{userData: string}	非必填，对象中的userData是透传参数，可用作截图数据的命名，或者多张截图数据的唯一标记。

详情

将当前白板view可视区内所有内容保存在图片中。

支持版本：2.0.0及以上。

flipToPage

flipToPage(targetPage: number): void

跳转到指定页面

参数

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

详情

跳转到指定页面。

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

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

flipToPrePage

flipToPrePage(): void

跳转到上一页

跳转到上一页。

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

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

flipToNextPage

flipToNextPage(): boolean

跳转到下一页

跳转到下一页。

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

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

操作结果

preStep

preStep(): void

跳转到上一步动画

跳转到上一步动画。

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

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

getCurrentPage

getCurrentPage(): number

获取当前显示的内容的页码

获取当前显示的内容的页码。

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

支持版本：2.0.0及以上。

当前显示的内容的页码

nextStep

nextStep(): void

跳转到下一步动画

跳转到下一步动画。

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

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

getPageCount

getPageCount(): number

获取总页码数

获取总页码数。

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

支持版本：2.0.0及以上。

总页码数

getVisibleSize

getVisibleSize(): Size

获取可见区域的大小

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

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

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

可见区域的大小

getCurrentSheetName

getCurrentSheetName(): string

获取当前展示的sheet名称

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

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

支持版本：2.0.0及以上。

当前展示的sheet名称

addImage

  addImage(type : ZegoSuperBoardViewImageType, positionX: number, positionY: number, address:  File | string | { path: string }, listener: Function): Promise<string>

插入图片到白板

参数

名称	类型	描述
type	ZegoSuperBoardViewImageType	图片类型，目前支持普通图片和自定义图形
positionX	number	图片插入位置的起始点，相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
positionY	number	图片插入位置的起始点，相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
address	File \| string \| { path: string }	图片地址，支持本地图片地址和网络图片地址
listener	Function	添加图片结果回调

详情

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

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

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

clearSelected

clearSelected(): void

删除选中的图元

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

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

支持版本：2.0.0及以上。

setBackgroundImage

setBackgroundImage(address: File | string | { path: string }, mode: ZegoSuperBoardViewImageFitMode): Promise<string>

向白板设置背景图

参数

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

详情

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

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

支持版本：2.0.0及以上。
使用限制：背景图片类型仅支持 JPG、JPEG、PNG、SVG、GIF 类型
注意事项：SVG 和 GIF 类型的背景图片只在 v2.17.0 及之后的版本支持

clearBackgroundImage

clearBackgroundImage(): void

清除白板的背景图

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

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

支持版本：2.0.0及以上。

stopPlayPPTVideo

stopPlayPPTVideo(): void

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

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

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

支持版本：2.0.0及以上。

ZegoSuperBoardSubViewImpl

方法

playMedia

playMedia(params: {id:string,ct?:number}): Promise<{code:number, message?:string} | boolean>

播放动态演示文件音视频

参数

名称	类型	描述
params	{id ,ct? }	接受音视频 html 元素的 id 值(#id)，当为视频时可以传入第二个参数单位为秒来控制视频进度

详情

通过传入音视频html元素的id来播放动态演示文件的音视频，当需要控制视频进度时可以传入第二个参数来指定视频的播放进度。

业务场景：被动端动态演示文件中音视频由于浏览器限制无法播放时调用，一般结合 onMediaPermission 回调来使用。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.12.0

switchSpeaker

switchSpeaker(label: string): Promise<{code:number, message?:string} | boolean>

动态演示文件指定扬声器设备

参数

名称	类型	描述
label	string	扬声器设备列表信息的label值

详情

通过传入扬声器设备的 label 来指定动态演示文件范围语音播放音频使用的设备。最佳实践请参考设置动态文件的扬声器。

业务场景：动态演示文件范围语音切换使用的扬声器设备。
默认值：在没有调用接口前，使用的是系统默认指定的扬声器设备。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.9.0
注意事项：该接口当前只支持 PC 端 Google Chrome 浏览器使用。

ZegoSuperBoardView

方法

getCurrentSuperBoardSubView

getCurrentSuperBoardSubView(): ZegoSuperBoardSubView | null

获取当前展示 superBoardSubView

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

支持版本：2.0.0 及以上。
注意事项：在开启 superBoardView 模式下生效

当前展示 superBoardSubView

switchSuperBoardSubView

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

切换到指定的SuperBoardSubView

参数

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

详情

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

相关回调：remoteSuperBoardSubViewSwitched。

返回值

操作结果