Board

Board

new Board(roomHandle, userId, width, height, backgroundColor, backgroundImage, title, outputWidth, outputHeight, description, extendData)

Description:
  • Board构造函数。 当白板的渲染宽(高)度与输出的宽(高)度不同时,输出的对应的x,y等坐标也是基于这个输出的宽(高)度重新计算的。
Source:
Example
var board = new Board();
Parameters:
Name Type Description
roomHandle Object 房间对象
userId String 创建者userId
width int 白板的渲染宽度
height int 白板的渲染高度
backgroundColor Object 白板的背景色
backgroundImage String 白板的背景图访问路径
title String 白标标题
outputWidth int 白板的输出宽度
outputHeight int 白板的输出高度
description String 描述
extendData String 扩展内容

Methods

(async) createAnnotation()

Description:
  • 创建批注
Source:

(async) createAnnotation()

Description:
  • 创建批注
Source:

getAnnotation()

Description:
  • 获取当前白板所属的批注
Source:

getAnnotation()

Description:
  • 获取当前白板所属的批注
Source:

removeAnnotation()

Description:
  • 删除当前白板所属的全部批注
Source:

removeAnnotation()

Description:
  • 删除当前白板所属的全部批注
Source:

setRenderWidthAndHeight(width, height)

Description:
  • 设置当前白板的渲染宽(高)度,输入的对应的x,y等坐标也是基于这个输入的宽(高)度重新计算的。
Source:
Parameters:
Name Type Description
width Object 白板的渲染宽度
height Object 白板的渲染高度

setRenderWidthAndHeight(width, height)

Description:
  • 设置当前白板的渲染宽(高)度,输入的对应的x,y等坐标也是基于这个输入的宽(高)度重新计算的。
Source:
Parameters:
Name Type Description
width Object 白板的渲染宽度
height Object 白板的渲染高度

updateBackgroundColor(backgroundColor)

Description:
  • 白板的背景色更改
Source:
Parameters:
Name Type Description
backgroundColor Object 更新白板的背景色

updateBackgroundColor(backgroundColor)

Description:
  • 白板的背景色更改
Source:
Parameters:
Name Type Description
backgroundColor Object 更新白板的背景色

updateBackgroundImage(backgroundImage)

Description:
  • 白板的背景图更改
Source:
Parameters:
Name Type Description
backgroundImage Object 更新白板的背景图

updateBackgroundImage(backgroundImage)

Description:
  • 白板的背景图更改
Source:
Parameters:
Name Type Description
backgroundImage Object 更新白板的背景图

updateWidthAndHeight(width, height)

Description:
  • 白板的宽度及高度更改
Source:
Parameters:
Name Type Description
width int 白板的宽度
height int 白板的高度

updateWidthAndHeight(width, height)

Description:
  • 白板的宽度及高度更改
Source:
Parameters:
Name Type Description
width int 白板的宽度
height int 白板的高度

(async) uploadImg2Server(accessToken, fileTarget)

Description:
  • 上传图片到服务器
Source:
Parameters:
Name Type Description
accessToken String token
fileTarget Object 文件对象,input控件选择的图片文件,支持jpeg/jpg/png格式
Returns:
Promise

(async) uploadImg2Server(accessToken, fileTarget)

Description:
  • 上传图片到服务器
Source:
Parameters:
Name Type Description
accessToken String token
fileTarget Object 文件对象,input控件选择的图片文件,支持jpeg/jpg/png格式
Returns:
Promise

Board

new Board(roomHandle, userId, width, height, backgroundColor, backgroundImage, title, outputWidth, outputHeight, description, extendData)

Description:
  • Board构造函数。 当白板的渲染宽(高)度与输出的宽(高)度不同时,输出的对应的x,y等坐标也是基于这个输出的宽(高)度重新计算的。
Source:
Example
var board = new Board();
Parameters:
Name Type Description
roomHandle Object 房间对象
userId String 创建者userId
width int 白板的渲染宽度
height int 白板的渲染高度
backgroundColor Object 白板的背景色
backgroundImage String 白板的背景图访问路径
title String 白标标题
outputWidth int 白板的输出宽度
outputHeight int 白板的输出高度
description String 描述
extendData String 扩展内容

Methods

(async) createAnnotation()

Description:
  • 创建批注
Source:

(async) createAnnotation()

Description:
  • 创建批注
Source:

getAnnotation()

Description:
  • 获取当前白板所属的批注
Source:

getAnnotation()

Description:
  • 获取当前白板所属的批注
Source:

removeAnnotation()

Description:
  • 删除当前白板所属的全部批注
Source:

removeAnnotation()

Description:
  • 删除当前白板所属的全部批注
Source:

setRenderWidthAndHeight(width, height)

Description:
  • 设置当前白板的渲染宽(高)度,输入的对应的x,y等坐标也是基于这个输入的宽(高)度重新计算的。
Source:
Parameters:
Name Type Description
width Object 白板的渲染宽度
height Object 白板的渲染高度

setRenderWidthAndHeight(width, height)

Description:
  • 设置当前白板的渲染宽(高)度,输入的对应的x,y等坐标也是基于这个输入的宽(高)度重新计算的。
Source:
Parameters:
Name Type Description
width Object 白板的渲染宽度
height Object 白板的渲染高度

updateBackgroundColor(backgroundColor)

Description:
  • 白板的背景色更改
Source:
Parameters:
Name Type Description
backgroundColor Object 更新白板的背景色

updateBackgroundColor(backgroundColor)

Description:
  • 白板的背景色更改
Source:
Parameters:
Name Type Description
backgroundColor Object 更新白板的背景色

updateBackgroundImage(backgroundImage)

Description:
  • 白板的背景图更改
Source:
Parameters:
Name Type Description
backgroundImage Object 更新白板的背景图

updateBackgroundImage(backgroundImage)

Description:
  • 白板的背景图更改
Source:
Parameters:
Name Type Description
backgroundImage Object 更新白板的背景图

updateWidthAndHeight(width, height)

Description:
  • 白板的宽度及高度更改
Source:
Parameters:
Name Type Description
width int 白板的宽度
height int 白板的高度

updateWidthAndHeight(width, height)

Description:
  • 白板的宽度及高度更改
Source:
Parameters:
Name Type Description
width int 白板的宽度
height int 白板的高度

(async) uploadImg2Server(accessToken, fileTarget)

Description:
  • 上传图片到服务器
Source:
Parameters:
Name Type Description
accessToken String token
fileTarget Object 文件对象,input控件选择的图片文件,支持jpeg/jpg/png格式
Returns:
Promise

(async) uploadImg2Server(accessToken, fileTarget)

Description:
  • 上传图片到服务器
Source:
Parameters:
Name Type Description
accessToken String token
fileTarget Object 文件对象,input控件选择的图片文件,支持jpeg/jpg/png格式
Returns:
Promise