Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAppConfig

Hierarchy

  • IAppConfig

Index

Properties

allowReplaceActiveBroadcaster

allowReplaceActiveBroadcaster: boolean

房间内存在主播时(视角跟随),是否允许其他用户设置自己为主播

canvasBgColor

canvasBgColor: string

白板背景色

API CHANGE:

3.6.0版本之前,请使用canvas_bg_color

3.6.0版本之后,请使用canvasBgColor。3.6.0之后canvas_bg_color依旧可以使用,但是未来可能不再支持

Optional disableAutoResize

disableAutoResize: boolean

默认为true true: 容器resize时,容器内元素大小不变 false:容器resize时,容器所代表的世界坐标系的宽度不变. 如果是等比例缩放,容器大小变化,则容器内元素内容和容器的相对位置不变

drawMergeDebug

drawMergeDebug: boolean

默认为false。仅当drawMergeInterval > 0时有效 设置为true时,会在涂鸦时打印两笔之间的时间差与曼哈顿距离,这样方便产品/开发设置合适的drawMergeInterval,以及drawMergeDist。

drawMergeDist

drawMergeDist: number

默认为200。仅当drawMergeInterval > 0时有效 注意该距离为两点之间的曼哈顿距离。即 Math.abs(x1 - x2) + Math.abs(y1 - y2)。这里的x,y均为屏幕上面的css像素点距离

drawMergeInterval

drawMergeInterval: boolean

默认为-1。 如果该值 <= 0, 则认为不对涂鸦进行合并。 如果该值 > 0, 则当两次涂鸦之间的间隔小于drawMergeInterval时,且第一笔的最后一点,和第二笔的第一点距离小于drawMergeDist时, 认为两次涂鸦为同一笔操作

previewCustomBg

previewCustomBg: boolean

预览图中是否包含自定义背景函数的绘制。默认为false

previewMode

previewMode: "fitDoc" | "fitContainer"

预览图的模式 fitDoc: 在预览图中,文档显示最大化 fitContainer: 在预览图中,当前白板页的容器显示最大化

showCursorNickname

showCursorNickname: boolean

共享鼠标位置时,是否显示鼠标所有者的昵称。和DrawPlugin.setShowCursor配合使用

showLaserNickname

showLaserNickname: boolean

显示激光笔时,是否显示激光笔所有者的昵称

showSelectNickname

showSelectNickname: boolean

显示选择框时,是否显示选择框所有者的昵称

staticDocType

staticDocType: "template" | "array"

该配置会影响addDoc时,添加静态文档的参数。

若你的所有客户白板版本都大于等于3.6.1, 则你应该使用'template' 若你的sdk版本小于3.6.1, 或者你需要和低版本的白板sdk互通,则你应该使用array

注意,如果使用array,在加载页数很大(如大于100)的静态文档时,可能会存在性能问题。

zoomSensitivity

zoomSensitivity: number

缩放灵敏度设置。这个值应该大于0,小于1。默认为0.91