Whiteboard Context

BoardContext provides whiteboard-related capabilities.

boardConnectionState

boardConnectionState: string;

Since v1.1.5.

The connection state of the whiteboard.

joinBoard

joinBoard: () => Promise<any>;

Since v1.1.5.

Joins a whiteboard room.

leaveBoard

leaveBoard: () => Promise<any>;

Since v1.1.5.

Leaves a whiteboard room.

room

room: object,

The whiteboard room object.

zoomValue

zoomValue: number,

The value of zooming in or out the whiteboard.

currentPage

currentPage: number,  

The current number of the whiteboard page.

totalPage

totalPage: number,

The total number of whiteboard pages.

courseWareList

courseWareList: array,

The list of the courseware.

currentColor

currentColor: string,

The color.

currentStrokeWidth

currentStrokeWidth: number,

The line thickness.

hasPermission

hasPermission: boolean,

Whether the user has the permission of drawing on the whiteboard.

currentSelector

currentSelector: string,

The whiteboard selector.

lineSelector

lineSelector: string,

The line drawing tool.

activeMap

activeMap: Record<string, boolean>,

The active whiteboard tools by default.

ready

ready: boolean,

Whether the whiteboard is ready.

tools

tools: array,

The list of the whiteboard editing tools.

changeStroke

async changeStroke(value: any): void

Set the line thickness.

changeHexColor

async changeHexColor(colorHex: string): void

Select a color.

mountToDOM

async mountToDOM(dom: HTMLDivElement | null): void

Mount or unmount the whiteboard to the DOM.

setTool

async setTool(tool: string): void

Switch tools.

zoomBoard

async zoomBoard(type: string): void

Zoom in or out the whiteboard.

setZoomScale

async setZoomScale(operation: string): void

Set the ration of zooming in or out.

changeFooterMenu

async changeFooterMenu(itemName: string): void

Set to which whiteboard page that you want to jump to.

downloadList

downloadList: array,

The list of downloadable classroom resources.

putSceneByResourceUuid

async putSceneByResourceUuid(uuid: string): void

Display the courseware on the whiteboard.

startDownload

async startDownload(taskUuid: string): void

Starts downloading a file.

updatePen

async updatePen(value: any): void

Update the pen.

boardPenIsActive

boardPenIsActive: boolean,

Whether the currently selected tool is a pen.

startOrStopSharing

async startOrStopSharing(): void

Start or stop screen sharing.

setLaserPoint

setLaserPoint(): void

Select the laser pointer.

resourcesList

resourcesList: array,

The list of the courseware.

refreshCloudResources

async refreshCloudResources(): void

Update the courseware list.

removeMaterialList

async removeMaterialList(resourceUuids: string[]): void

Remove the courseware.

cancelUpload

async cancelUpload(): void

Cancels uploading a file to the classroom.

doUpload

async doUpload(payload: any): void

Uploads a file to the classroom.

closeMaterial

async closeMaterial(resourceUuid: string): void

Closes the file.

installTools

async installTools(tools: any[]): void

Install tools.

personalResources

personalResources: array,

The list of courseware uploaded by the teacher through the Flexible Classroom client.

publicResources

publicResources: array,

The list of courseware assigned by the teaching institution.

revokeUserPermission

async revokeUserPermission(userUuid: string): void

Cancel the whiteboard authorization.

grantUserPermission

async grantUserPermission(userUuid: string): void

Grant the permission of drawing on the whiteboard to a specified student.