ViewMode #

类型：enum
视图缩放同步选项

• 成员

  属性	值	说明
  kBroadcast	0	视图控制模式。本端的视图设置将同步给其他用户，设置为自由模式的用户除外。 同一个白板可以有多个控制方，缩放设置为最近一次调用 API 传入的设置。
  kFollow	1	视图跟随模式
  kFree	2	自由模式，不跟随其他用户的视图缩放设置。同时本地的视图缩放设置也不会影响到设置为跟随的用户。

RemovePagesResult #

类型：interface
页面移除事件
userId
类型：string
移除页面的用户
boardId
类型：number
白板 ID
pageIds
类型：string[]
被删除页面 ID

ExportSnapshotOptions #

类型：interface
白板快照选项
pageIndex
类型：number | undefined
白板页索引, 默认为当前页。
withElements
类型：boolean | undefined
是否导出笔迹, 默认为 true，导出
withBackGround
类型：boolean | undefined
是否导出页面背景, 默认为 true，导出

ZoomOperation #

类型：interface
手势缩放拖拽配置信息
enableTouchZoom
类型：boolean | undefined
是否允许双指缩放，双指移动，默认 true
enableWheelZoom
类型：boolean | undefined
是否允许鼠标滚轮缩放，鼠标滚轮移动，默认 true

EditType #

编辑动作类型

export enum ToolMode {
POINTER = 'pointer',//选择工具。
FILE_ARROW = 'fileArrow',// PPT 操作工具。选择这个工具后，可以对 PPT 进行翻页、播放页面上的多媒体等操作。
PENCIL_BRUSH = 'pencilBrush',//画笔
LINE = 'line',//直线
CIRCLE = 'circle',//圆形
RECT = 'rect',//矩形
ARROW = 'arrow',//箭头
TEXT = 'textbox',//文本
ERASER = 'eraser',//橡皮擦工具
LASER = 'laser',//激光笔工具
ZOOM = 'zoom',//拖拽工具，需要先放大，才能拖拽

• 类型

  ToolMode | ''
  

WebBackgroundInfo #

类型：interface
bkColor
类型：string | undefined
背景颜色。例如 rgba(0,0,0,255)。
bkImage
类型：string | undefined
背景图片。
bkImageFillType
类型：BkFillType | undefined
背景图片填充设置。
bkImageSize
类型：BkImageSize | undefined
背景图片尺寸。

BkFillType #

类型：enum
背景图片填充方式

• 成员

  属性	值	说明
  kFill	0	平铺窗口，按照白板比例缩放图片进行填充。
  kCenter	1	居中放置，不缩放。
  kHidden	2	等比例缩放，如果画布和图片比例不一致，将对图片进行裁切。

BkImageSize #

类型：interface
背景图片尺寸
width
类型：number
宽，单位为画布宽度的万分之一。
height
类型：number
高，单位为画布高度的万分之一。

SetBoardBackgroundResult #

类型：interface
设置白板背景信息成功事件
userId
类型：string
设置白板背景的用户
boardId
类型：number
白板 ID
bkInfo
类型：WebBackgroundInfo
白板背景设置

AddImageOptions #

类型：interface
图片的位置和尺寸
top
类型：number | undefined
放置位置，垂直方向偏移量，坐标范围 0-10000
left
类型：number | undefined
放置位置，水平方向偏移量，坐标范围 0-10000
width
类型：number | undefined
宽度。[1, 10000]。单位为画布宽度的万分之一。
height
类型：number | undefined
高度。[1, 10000]。单位为画布高度的万分之一。

AddMediaOptions #

类型：interface
音视频选项
title
类型：string | undefined
标题。不超过 200 个字符。支持的字符为中文、英文、数字、下划线(_) 和 连线符(-)。

ShapeStyle #

类型：interface
选择框样式。
motionType
类型：MotionType | undefined
锚点形状。
motionSize
类型：number | undefined
锚点宽度。
motionBorderWidth
类型：number | undefined
锚点边框线条宽度。
motionBorderColor
类型：string | undefined
锚点边框颜色。例如 rgba(0,0,0,255)。
motionFillColor
类型：string | undefined
锚点填充颜色。例如 rgba(0,0,0,255)。
motionTransparent
类型：boolean | undefined
锚点是否透明。
borderWidth
类型：number | undefined
选择框宽度。
borderColor
类型：string | undefined
选择框颜色。例如 rgba(0,0,0,255)。
rotateImage
类型：string | undefined
旋转手柄图标资源地址。
rotateDistance
类型：number | undefined
旋转手柄距离选择框顶点的距离。

MotionType #

类型：enum

• 成员

  属性	值	说明
  kRect	0	矩形。
  kCircle	1	圆形。

WebPageCreateInfo #

类型：interface
页面信息。
pageId
类型：string | undefined
页面 ID。
bkInfo
类型：WebBackgroundInfo | undefined
背景设置。
extra
类型：string | undefined
补充信息。