ZegoSuperBoard Super Board

Documentation

Console

中文站 English

Documentation
Super Board
Function Overview
Function Overview

Function Overview

Last updated：2025-09-09 11:48

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
sharedInstance	Get ZegoSuperBoardManager instance object
initWithConfig:config:complete:	Initialize the ZegoSuperBoard SDK
enableSuperBoardView:enable:	Set whether to use SuperBoardView
unInit	Uninitialize the SDK
getSDKVersion	Obtain the SDK version number

ZegoSuperBoardManager create, destroy, switch function

Method	Description
setManagerListener:listener:	set callback for SDK
createWhiteboardView:config:complete:	Creating a pure whiteboard
createFileView:config:complete:	Create a file
destroySuperBoardSubView:uniqueID:complete:	Destroys the specified SuperBoardSubView view
querySuperBoardSubViewList:complete:	Query the server for the list of SuperBoardSubView that currently exists
getSuperBoardSubView:uniqueID:	Gets the specified SuperBoardSubView

ZegoSuperBoardSubView Manipulation (paging, scrolling and others)

Method	Description
flipToPage:targetPage:complete:	Jump to the specified page
flipToPrePage:complete:	Jump to the previous page
flipToNextPage:complete:	Jump to the next page
preStep:complete:	Jump to the previous step animation
nextStep:complete:	Jump to the next step animation

Functions related to ZegoSuperBoard drawing

Method	Description
addTextEditWithComplete:complete:	Add text to the whiteboard View, and an input box will pop up from the bottom of the whiteboard after calling.
addText:text:positionX:positionY:complete:	Add custom text to the whiteboard
undo	Undo the last operation of the whiteboard
redo	Restore the undone operation on the whiteboard
clearCurrentPage:complete:	Clear the primitives on the current page of the whiteboard
clearAllPage:complete:	Clear the primitives on all page of the whiteboard
addImage:type :address:positionX:positionY:complete:	Insert picture to whiteboard
clearSelected:complete:	Delete the selected element
setBackgroundImageWithPath:imagePath:mode:complete:	Set the background image to the whiteboard
clearBackgroundImageWithComplete:complete:	Clear the background image of the whiteboard
setCustomFontWithName:regularFontName:boldFontName:	Set custom new font

ZegoSuperBoardSubView Function to obtain information about files

Method	Description
getThumbnailUrlList	Get the current file thumbnail list, only supports PDF, PPT, dynamic PPT, H5 file format
getPPTNotes:page:	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

ZegoSuperBoardManager Cleanup related resources

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:mode:	Set the operating mode of the current whiteboard
setWhiteboardBackgroundColor:color:	Set the whiteboard background color in the container

ZegoSuperBoardView switch operation related

Method	Description
switchExcelSheet:sheetIndex:complete:	Switch the excel file to the specified sheet page
switchSuperBoardSubView:uniqueID:complete:	Switch to the specified SuperBoardSubView
switcSuperBoardSubView:uniqueID:sheetIndex:complete:	Toggles the specified SuperBoardSubView to the specified sheet

ZegoSuperBoardManager personalized Settings

Method	Description
setCustomizedConfig:value:key:	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:key:	Get the value of the set configuration item

Page Directory

Free trial