Documentation
Super Board
Function Overview
Function Overview

Function Overview

Last updated：2025-08-27 12:10

ZEGOCLOUD Super Board provides a complete set of multi-person real-time interactive whiteboard services for you to quickly build in whiteboard capabilities into your applications.

SDK Initialization

Method	Description
initWithConfig	Initialize the ZegoSuperBoard SDK
enableSuperBoardView	Set whether to use SuperBoardView
unInit	Uninitialize the SDK
getSDKVersion	Obtain the SDK version number

ZegoSuperBoardManager create, destroy, switch function

Method	Description
getSuperBoardSubViewModelList	Get the information of superBoardSubView saved by the SDK
createWhiteboardView	Creating a common whiteboard
createFileView	Create a file view
destroySuperBoardSubView	Destroys a specified SuperBoardSubView view
querySuperBoardSubViewList	Query the server for the list of SuperBoardSubView that currently exists
getSuperBoardSubView	Gets the specified SuperBoardSubView

ZegoSuperBoardSubView Manipulation (paging, scrolling and others)

Method	Description
flipToPage	Jump to the specified page
flipToPrePage	Jump to the previous page
flipToNextPage	Jump to the next page
preStep	Jump to the previous animation
getCurrentPage	Get the page number of the currently displayed content
nextStep	Jump to the next animation
getPageCount	Get the total number of pages
getVisibleSize	Get the size of the visible area of the file
getCurrentSheetName	Get the name of the currently displayed sheet
getCurrentSuperBoardSubViewModel	Get the superBoardSubViewModel that is currently displayed

Method	Description
setCustomFontFromAsset	Set custom font source file path.
inputText	Add text to the whiteboard View, and an input box will pop up from the bottom of the whiteboard after calling.
addText	Add custom text to the whiteboard
undo	Undo the last operation of the whiteboard
redo	Restore the undone operation on the whiteboard
clearCurrentPage	Clear the primitives on the current page of the whiteboard
clearAllPage	Clear the primitives on all page of the whiteboard
addImage	Insert picture to whiteboard
clearSelected	Delete the selected element
setBackgroundImage	Set the background image to the whiteboard
clearBackgroundImage	Clear the background image of the whiteboard

ZegoSuperBoardSubView Function to obtain information about files

Method	Description
getExcelSheetNameList	Get the list of Excel sheet names
getThumbnailUrlList	Get the current file thumbnail list, only supports PDF, PPT, dynamic PPT, H5 file format
getPPTNotes	Get the notes of the specified page number of the PPT

ZegoSuperBoardSubView Element operation within file

Method	Description
stopPlayPPTVideo	Stop the video being played on the current dynamic ppt page

Method	Description
clearCache	Clear cache resources related to files and whiteboards
clear	Empty resources in the room called upon checkout

ZegoSuperBoardSubView Operation permission

Method	Description
setOperationMode	Set the operating mode of the current whiteboard

ZegoSuperBoardSubView Personalized Settings

Method	Description
setWhiteboardBackgroundColor	Set the background color of the whiteboard

Method	Description
switchExcelSheet	Switch the excel file to the specified sheet page
switchSuperBoardSubView	Switch to the specified SuperBoardSubView

ZegoSuperBoardManager personalized Settings

Method	Description
enableCustomCursor	Set whether to enable the local custom cursor
enableRemoteCursorVisible	Set whether to enable the display of remote custom cursor
getCustomText	Get the default values of text
setCustomText	Set the default values of text
setCustomizedConfig	Setting initialization parameters is optional For example: The key value is logPath, which is the directory where the SDK records logs. The key value is cachePath, the address of the directory cached by the SDK.
getCustomizedConfig	Get the value of the set configuration item
enableSyncScale	Set whether to synchronize the zoom to other members in the room
enableResponseScale	Whether to respond to the zoom of other members in the room
enableHandwriting	set whether to enable the handwriting effects
setToolType	Set the whiteboard tool type
getToolType	Get the type of whiteboard tool being used.
setFontBold	Set text bold
setFontItalic	Set text italic
setFontSize	Set the font size
getFontSize	Get the font size
setBrushSize	Set the brush size
getBrushSize	Get the brush size
setBrushColor	Set the brush color
getBrushColor	Get the brush color

Page Directory