API参考

CRBoard_CreateWhiteBoard

• 详情：CRBoard_CreateWhiteBoard(width, height, pageCount, pageMode, extInfo).then(function(BoardInfoObject){}).catch(function(errObject){})
• 描述：创建白板
• 返回值：Promise
• 参数：

  参数	类型	必传	含义
  width	Number	是	宽度
  height	Number	是	白板高度
  pageCount	Number	是	页数
  pageMode	Number	是	白板翻页类型，详见：BOARDVIEW_PAGE_MODE
  extInfo	String	否	额外信息

• 回调参数：

  参数	类型	含义
  BoardInfoObject	Object	白板信息，详情请参考BoardInfoObject

CRBoard_CloseBoard

• 详情：CRBoard_CloseBoard(boardID).then(resObject=>{}).catch(errObject=>{})
• 描述：关闭白板
• 返回值：Promise
• 参数：

  参数	类型	必传	含义
  boardID	String	是	白板ID

CRBoard_GetBoardInfo

• 详情：CRBoard_GetBoardInfo(boardID)
• 描述：获取白板信息
• 返回值：BoardInfoObject
• 参数：

  参数	类型	必传	含义
  boardID	String	是	白板ID

CRBoard_GetAllBoard

• 详情：CRBoard_GetAllBoard()
• 描述：获取房间中的所有白板
• 返回值：BoardInfoObject[ ]

CRBoard_UpdateBoardExInfo

• 详情：CRBoard_UpdateBoardExInfo(boardID, extInfo).then(resObject=>{}).catch(errObject=>{})
• 描述：更新白板的扩展信息
• 返回值：Promise
• 参数：

  参数	类型	必传	含义
  boardID	String	是	白板ID
  extInfo	String	否	额外信息

CRBoard_GetCurrentBoard

• 详情：CRBoard_GetCurrentBoard()
• 描述：获取当前白板ID
• 返回值：白板ID(String)

CRBoard_SetCurrentBoard

• 详情：CRBoard_SetCurrentBoard(boardID)
• 描述：设置当前白板ID
• 返回值：Promise
• 参数：

  参数	类型	必传	含义
  boardID	String	是	白板ID

CRBoard_NotifyInitBoardList

• 详情：CRBoard_NotifyInitBoardList.callback = function(BoardInfoObjects){}
• 描述：初始化完成后，通知白板列表
• 回调参数：

  参数	类型	含义
  BoardInfoObjects	Array	白板对象列表，详见：BoardInfoObject

CRBoard_NotifyCreateBoard

• 详情：CRBoard_NotifyCreateBoard.callback = function(BoardInfoObject, opID){}
• 描述：通知创建白板
• 回调参数：

  参数	类型	含义
  BoardInfoObject	Object	白板信息，详情请参考BoardInfoObject
  opID	String	操作者ID

CRBoard_NotifyCloseBoard

• 详情：CRBoard_NotifyCloseBoard.callback = function(boardID, opID){}
• 描述：通知关闭白板
• 回调参数：

  参数	类型	含义
  boardID	String	白板ID
  opID	String	操作者ID

CRBoard_NotifyBoardExinfoUpdated

• 详情：CRBoard_NotifyBoardExinfoUpdated.callback = function(boardID, extInfo, opID){}
• 描述：通知白板的扩展信息改变
• 回调参数：

  参数	类型	含义
  boardID	String	白板ID
  extInfo	String	额外信息
  opID	String	操作者ID

CRBoard_NotifyCurrentBoard

• 详情：CRBoard_NotifyCurrentBoard.callback = function(boardID, opID){}
• 描述：通知当前白板改变
• 回调参数：

  参数	类型	含义
  boardID	String	白板ID
  opID	String	操作者ID

CRBoard_NotifyBoardScale

• 详情：CRBoard_NotifyBoardScale.callback = function(boardID,scale,opID){}
• 描述：通知白板缩放改变
• 回调参数：

  参数	类型	含义
  boardID	String	白板ID
  scale	number	白板缩放比
  opID	String	操作者ID

CRBoard_BoardView

• 详情：new CRBoard_BoardView()
• 描述：创建白板View实例
• 返回值：返回白板UI组件的实例

const boardView = new CRBoard_BoardView(); // 创建白板UI显示组件

CRBoard_BoardView_handler

• 详情：CRBoard_BoardView.handler()
• 描述：获取白板View的Dom对象
• 返回值：返回白板UI组件的Dom对象

CRBoard_BoardView_resize

• 详情：CRBoard_BoardView.resize()
• 描述：重置白板view的尺寸
• 返回值：无

CRBoard_BoardView_setBoardID

• 详情：CRBoard_BoardView.setBoardID(boardID, attr)
• 描述：设置白板View对应的白板ID
• 返回值：无
• 参数：

  参数	类型	必传	含义
  boardID	String	是	白板ID
  BoardViewAttrObject	Object	是	白板权限属性,详见：BoardViewAttrObject

  const attr = {
    readOnly: false, // 是否只读
    asyncPage: true, // 是否同步发送翻页
    followPage: true, // 是否跟随翻页
    asyncScale: true, // 是否同步发送缩放
    followScale: true, // 是否跟随缩放
  }
  boardView.setBoardID(boardID, attr);

CRBoard_BoardView_getAttr

• 详情：CRBoard_BoardView.getAttr()
• 描述：获取白板View属性
• 返回值：白板权限属性,详见：BoardViewAttrObject

CRBoard_BoardView_setAttr

• 详情：CRBoard_BoardView.setAttr(BoardViewAttrObject)
• 描述：设置白板View属性
• 返回值：无
• 参数：

  参数	类型	必传	含义
  BoardViewAttrObject	Object	是	白板权限属性,详见：BoardViewAttrObject

CRBoard_BoardView_setCurPage

• 详情：CRBoard_BoardView.setCurPage(pageNum)
• 描述：设置白板View的当前页
• 返回值：无
• 参数：

  参数	类型	必传	含义
  pageNum	Number	是	当前页

CRBoard_BoardView_getCurPage

• 详情：CRBoard_BoardView.getCurPage()
• 描述：获取白板View的当前页
• 返回值：当前页(Number)

CRBoard_BoardView_setToolType

• 详情：CRBoard_BoardView.setToolType(type)
• 描述：设置白板View的工具类型
• 返回值：无
• 参数：

  参数	类型	必传	含义
  type	Number	是	画笔的形状定义，参见BOARDVIEW_SHAPE_TYPE

CRBoard_BoardView_getToolType

• 详情：CRBoard_BoardView.getToolType()
• 描述：获取白板View的工具类型
• 返回值：画笔的形状，参见BOARDVIEW_SHAPE_TYPE

CRBoard_BoardView_setToolAttr

• 详情：CRBoard_BoardView.setToolAttr(attrObj)
• 描述：设置白板View的画笔属性
• 返回值：无
• 参数：

  参数	类型	必传	含义
  attrObj	BoardViewToolAttrObject	是	白板画笔属性,，详见：BoardViewToolAttrObject

CRBoard_BoardView_getToolAttr

• 详情：CRBoard_BoardView.getToolAttr()
• 描述：获取白板View的画笔属性
• 返回值：画笔的形状，参见 BoardViewToolAttrObject

CRBoard_BoardView_setCursor

• 详情：CRBoard_BoardView.setCursor(cursor)
• 描述：设置白板view的鼠标样式
• 返回值：鼠标样式，如："text"、"move"、"url(../whiteBoardDemo/imgs/鼠标光标-铅笔.cur),default" 等

CRBoard_BoardView_clearCurPage

• 详情：CRBoard_BoardView.clearCurPage()
• 描述：清空当前页标注
• 返回值：无

CRBoard_BoardView_clearAllPage

• 详情：CRBoard_BoardView.clearAllPage()
• 描述：清空整个白板View的标注
• 返回值：无

CRBoard_BoardView_getUndoEnableState

• 详情：CRBoard_BoardView.getUndoEnableState()
• 描述：获取是否可以撤销上一步的操作
• 返回值：Boolean

CRBoard_BoardView_getRedoEnableState

• 详情：CRBoard_BoardView.getRedoEnableState()
• 描述：获取是否可以做恢复上一步的操作
• 返回值：Boolean

CRBoard_BoardView_undo

• 详情：CRBoard_BoardView.undo()
• 描述：撤消上一步操作
• 返回值：无

CRBoard_BoardView_redo

• 详情：CRBoard_BoardView.redo()
• 描述：恢复上一步撤销的操作
• 返回值：无

CRBoard_BoardView_setScale

• 详情：CRBoard_BoardView.setScale(scale)
• 描述：设置白板缩系数
• 返回值：无
• 参数：

  参数	类型	必传	含义
  scale	Number	是	缩放值（200代表2倍，范围在20~500）

CRBoard_BoardView_getScale

• 详情：CRBoard_BoardView.getScale()
• 描述：获取白板缩放值
• 返回值：缩放值（200代表2倍，范围在20~500）

CRBoard_BoardView_setCanvasStyle

• 详情：CRBoard_BoardView.setCanvasStyle(styleObject)
• 描述：设置Canvas的样式
• 返回值：无
• 参数：

  参数	类型	必传	含义
  styleObject	Object	是	样式对象，key值使用驼峰命名。例如：{"backgroundColor": "#000"}

CRBoard_BoardView_notifyBoardCurPageChanged

• 详情：CRBoard_BoardView.notifyBoardCurPageChanged.callback = function(curPage, opID){}
• 描述：通知白板view翻页改变
• 回调参数：

  参数	类型	含义
  curPage	Number	当前页码
  opID	String	操作者ID

CRBoard_BoardView_notifyRedoEnableChanged

• 详情：CRBoard_BoardView.notifyRedoEnableChanged.callback = function(redoStatus){}
• 描述：通知白板view是否可以重做
• 回调参数：

  参数	类型	含义
  redoStatus	Boolean	是否可以redo

CRBoard_BoardView_notifyUndoEnableChanged

• 详情：CRBoard_BoardView.notifyUndoEnableChanged.callback = function(undoStatus){}
• 描述：通知白板view是否可以撤销
• 回调参数：

  参数	类型	含义
  undoStatus	Boolean	是否可以undo

CRBoard_BoardView_notifyScaleChanged

• 详情：CRBoard_BoardView.notifyScaleChanged.callback = function(wId, scale, opID){}
• 描述：通知白板缩放系数改变
• 回调参数：

  参数	类型	含义
  boardID	String	白板ID
  scale	Number	缩放值（200代表2倍，范围在20~500）
  opID	String	操作者ID

CRBoard_BoardView_notifyUserTextInput

• 详情：CRBoard_BoardView.notifyUserTextInput.callback = function(callback){}
• 描述：通知点击白板后将要插入文本
• 回调参数：

  参数	类型	含义
  callback	Function	触发此函数将文本插入白板

//仅当BOARDVIEW_SHAPE_TYPE==6时，点击了白板才会触发此回调
boardView.notifyUserTextInput.callback = function(callback){
    const value = prompt("请输入文本");
    callback(value);    //将文本插入到白板中
}

CRBoard_BoardView_notifyMarkException

• 详情：CRBoard_BoardView.notifyMarkException.callback = function(sdkErr){}
• 描述：通知白板异常
• 回调参数：

  参数	类型	含义
  sdkErr	Object	错误码：sdkErr.errCode，详见：BOARDVIEW_EXCEPTION_CODE； 错误描述：sdkErr.errDesc