Function Overview
2026-01-23
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 |
|---|---|
| clearLog | Upload and clear the local cache log |
| getInstance | Get ZegoSuperBoardManager instance object |
| setLogConfig | Log advanced configuration |
| init | Initialize the ZegoSuperBoard SDK |
| enableSuperBoardView | Set whether to use SuperBoardView |
| unInit | Uninitialize the SDK |
| getSDKVersion | Obtain the SDK version number |
| on | Register to listen for events |
| off | Delete listening event |
ZegoSuperBoardManager create, destroy, switch function
| Method | Description |
|---|---|
| createPreviewFileView | Create a view for previewing the specified file |
| destroyAllSuperBoardSubView | Destroy all SuperBoardSubViews |
| getCurrentPreview | Get the currently previewed file. |
| getPreviewList | Get the list of preview views. |
| switchPreview | Switch the currently previewed file |
| createWhiteboardView | Creating a pure whiteboard |
| createFileView | Create document whiteboard |
| destroySuperBoardSubView | Destroys the specified SuperBoardSubView view |
| querySuperBoardSubViewList | Query the server for the list of SuperBoardSubView that currently exists |
| getSuperBoardSubView | Gets the specified SuperBoardSubView |
| attachSuperBoardSubView | Add SuperBoardSubView to the view |
ZegoSuperBoardSubView Manipulation (paging, scrolling and others)
| Method | Description |
|---|---|
| getCurrentStep | Animation steps to get the current page number of the dynamic PPT, starting from 1 |
| setScaleFactor | Zoom superBoardSubView |
| getModel | Get the model data corresponding to the whiteboard |
| flipToPage | Jump to the specified page |
| flipToPrePage | Jump to the previous page |
| flipToNextPage | Jump to the next page |
| preStep | Jump to the previous step animation |
| getCurrentPage | Get the page number of the currently displayed content |
| nextStep | Jump to the next step 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 |
| getCurrentSuperBoardSubView | Get the current display superBoardSubView |
Functions related to ZegoSuperBoard drawing
| Method | Description |
|---|---|
| clearSelected | Delete the selected element |
| reloadView | Reload SubView |
| 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 |
ZegoSuperBoardManager File upload transcoding and caching
| Method | Description |
|---|---|
| uploadFile | Upload files to the ZegoSuperBoard service |
| cancelUploadFile | Cancel the upload action during file upload |
| cacheFile | Request file resources in advance |
| cancelCacheFile | Cancel the cache action in the process of caching files |
| uploadH5File | Upload custom H5 courseware |
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 |
|---|---|
| snapshot | Get a snapshot of the current whiteboard |
| 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 |
ZegoSuperBoardSubView Operation permission
| Method | Description |
|---|---|
| setOperationMode | Set the operating mode of the current whiteboard |
ZegoSuperBoardSubView Personalized Settings
| Method | Description |
|---|---|
| playMedia | Play dynamic presentation files, audio and video |
| switchSpeaker | A dynamic presentation file specifies a speaker device |
ZegoSuperBoardView switch operation related
| Method | Description |
|---|---|
| getSuperBoardView | Get SuperBoardView object |
| switchSuperBoardSubView | Switch to the specified SuperBoardSubView |
ZegoSuperBoardManager personalized Settings
| Method | Description |
|---|---|
| enableCustomCursor | |
| enableRemoteCursorVisible | Set whether to enable the display of remote custom cursor |
| getWhiteboardBackgroundColor | |
| setCustomCursorAttribute | Customize the local custom cursor |
| setCustomizedConfig | Set configuration items |
| getCustomizedConfig | Get the value of the set configuration item |
| setWhiteboardBackgroundColor | Set the background color of the whiteboard |
| setDeferredRenderingTime | Set the delay rendering time of the local SubView |
| 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 open the pen sharp |
| isHandwritingEnabled | Get whether to turn on the stroke effect |
| setToolType | Set the whiteboard tool type |
| getToolType | Get the type of whiteboard tool being used. |
| setFontBold | Set text bold |
| isFontBold | Get whether the text is bold |
| setFontItalic | Set whether the text of the text tool is italicized. |
| isFontItalic | Get whether the text is italic effect |
| setFontSize | Set text size |
| getFontSize | Get text size |
| setBrushSize | Set the brush thickness |
| getBrushSize | Get brush thickness |
| setBrushColor | Set pen color |
| getBrushColor | Get the brush color |
| getScaleFactor | Get the zoom information of the current superBoardSubView |
ZegoSuperPreviewView related operation
| Method | Description |
|---|---|
| flipPage | Jump to the specified step of the specified slide in the dynamic PPT |
| getContentSize | Get the width and height of the document content. |
| getCurrentPage | Get the page number of the currently displayed file. |
| getFileID | Get the file ID |
| getFileType | Get the file type. |
| getPPTNotes | Get the remarks on the specified page of the PPT. |
| getThumbnailUrlList | Get the thumbnail list of the current file. Only PDF, PPT, and dynamic PPT file formats are supported. |
| getVerticalPercent | Get the percentage of the current vertical offset (vertical scroll bar) |
| getVisibleSize | Get the width and height of the visible area of the current file. |
| loadFile | Load and render the file. |
| nextStep | The next step of the dynamic PPT. |
| onLoadFileCallBack | Load previewfile callback |
| playAnimation | Play the animations of the dynamic PPT. Play the animations of the dynamic PPT. |
| previousStep | The previous step of the dynamic PPT. |
| reloadView | Reload the file View |
| scrollTo | Jump to a specific position in the file by percentage. |
| setScaleFactor | Zoom the current preview view. |
| stopPlay | Stop the audio and video playback on a certain page of the local dynamic PPT file. |
| switchSheet | Switch the Excel file to the specified sheet. |
| unloadFile | Unload the file from the view. |
| ZegoSuperBoardPreviewFileType | Preview file types |