RtcWhiteboard

属性列表

接口列表

事件列表

DingRTC 全局事件

接口详情

open()

打开白板，同时加入白板会话

类型签名

open(wrapperEle: HTMLElement): Promise<void>;

入参：

返回

Promise<void>

leave()

离开该白板会话，其他用户也会收到当前用户离开的事件。 用于中途离开白板，对其他用户无影响。

调用后当前白板实例仍然保留，可通过id获取到白板实例。 如果后续仍想继续使用白板，可以在获取白板实例后调用joinSession再次入会。

类型签名

leave(): void;

返回

void

close()

关闭本地白板，但未关闭白板会话

类型签名

close(): void;

返回

void

stop()

关闭该白板，其他用户也会收到白板关闭信号。 用于结束白板，影响所有用户。

调用后当前白板实例会被清理回收。

类型签名

close(): void;

返回

void

joinSession()

重新加入白板

类型签名

joinSession(): void;

返回

void

addBackgroundImages()

导入指定数量的背景图并创建一个新的文档，以这些图片作为背景

类型签名

addBackgroundImages(urls: string[], docName?: string, docId?: string): void;

入参：

返回

void

addImageShape()

添加图片到白板中

类型签名

addImageShape(url: string): Promise<void>;

入参：

返回

Promise<void>

addPdfDoc()

通过 URL 添加 PDF 文档，返回文档的docId

类型签名

addPdfDoc(url: string, name: string, docId?: string, fileKey?: string): string;

入参：

返回

string

addStamp()

添加图章资源

类型签名

addStamp(stampId: string, url: string, resizable: boolean): void;

入参：

返回

void

addPage()

添加一个新页面到最后

类型签名

addPage: (autoSwitch?: boolean) => any;

入参：

返回

any

alignVision()

会中单次同步视角，其他端会被强制设置为与设定的视角一致（该设置仅对当前页面生效）

类型签名

alignVision(): void;

返回

void

clearContents()

清除所有用户在画布上的内容，需要admin权限

类型签名

clearContents(curPage: boolean, clearType: 'all' | 'draws' |'backgroundImage'): void;

入参：

返回

void

clearDocContents()

清除某个文档的内容，需要admin权限

类型签名

clearContents(docId: string, clearType: 'all' | 'draws' |'backgroundImage'): void;

入参：

返回

void

clearUserContents()

清除某个用户绘制的内容，清除别人绘制内容需要admin权限

类型签名

clearUserContents(userId: string, curPage: boolean, clearType: WBClearType): void;

入参：

返回

void

center()

使白板视野回到居中位置（初始位置）

类型签名

center(doc?: any): void;

入参：

返回

void

createDoc()

创建文档

类型签名

createDoc(totalPages: number, docName: string, width?: number, height?: number, docId?: string): void;

入参：

返回

void

deleteDoc()

删除文档

类型签名

deleteDoc(docId: string, switchDocId?: string): void;

入参：

返回

void

disableCursorSync()

关闭光标位置同步功能

类型签名

disableCursorSync(): void;

返回

void

disableWheelScale()

禁止通过滚轮缩放画布

类型签名

disableWheelScale(): void;

返回

void

disableScaleAndMove()

禁止手势缩放面板和移动画布

类型签名

disableScaleAndMove(): void;

返回

void

enableCursorSync()

启用光标位置同步功能

类型签名

enableCursorSync(): void;

返回

void

enableScaleAndMove()

启用手势缩放面板和移动画布

类型签名

enableScaleAndMove(): void;

返回

void

enableWheelScale()

通过滚轮缩放画布

类型签名

enableWheelScale(): void;

返回

void

enumerateDocs()

列举出所有的文档信息

类型签名

enumerateDocs(): {
        docId: string;
        name: string;
        creator: string;
        currentPage: number;
        fileKey: string;
    }[];

返回

{

docId: string;

name: string;

creator: string;

currentPage: number;

fileKey: string;

}[];

getCurrentPageNumber()

获取当前页码

类型签名

getCurrentPageNumber(): number;

返回

number

getCursorSyncType()

获取光标同步类型，是同步所有光标移动，还是只有光标在绘制时同步

类型签名

getCursorSyncType(): "all" | "write";

返回

"all" | "write"

getToolType()

获取当前的工具类型

类型签名

getToolType(): ShapeType;

返回

ShapeType

getStatistics()

统计用户创建的图形数据

类型签名

getStatistics(): {
        userId: string;
        shapes: {
            shapeStyle?: ShapeStyle;
            shapeId: string;
            visible: boolean;
            type: ShapeType;
            fontStyle?: FontStyle;
            text?: string;
            creator: string;
        }[];
    }[];

返回

{ userId: string; shapes: { shapeStyle?: ShapeStyle; shapeId: string; visible: boolean; type: ShapeType fontStyle?: FontStyle; text?: string; creator: string; }[]; }[]

getTotalNumberOfPages()

获取当前激活文档总白板页码数

类型签名

getTotalNumberOfPages(): number;

返回

number

getTranslate()

获取画板当前在水平和竖直方向的位移

类型签名

getTranslate(): {
        x: number;
        y: number;
    };

返回

{

x: number;

y: number;

}

gotoPage()

跳转到指定页码（从 0 开始）

类型签名

gotoPage(pageIndex: number, docId?: string, autoSwitchToDoc?: boolean): void;

入参：

返回

void

insertPage()

插入文档

类型签名

insertPage(pageIndex: number, autoSwitch?: boolean, docId?: string, autoSwitchToDoc?: boolean): any;

入参：

返回

void

nextPage()

切换到下一页

类型签名

nextPage(): void;

返回

void

prevPage()

切换到上一页

类型签名

prevPage(): void;

返回

void

removePage()

删除指定页面

类型签名

removePage: (index?: number, docId?: string) => void;

入参：

返回

void

initVision()

设置白板视窗位置，画布会自动缩放到合适的比例，保证所选取的视窗在当前可见区域的正中央。 这是对白板会议的全局设置，设定后其他用户也会遵循这个配置。

在指定 sizeConfig 后，默认白板新建的空白白板页也会遵循这个配置。 （动态课件、转码文档、包含背景图的页面除外，这些版面会根据课件或背景图作合适的缩放）

类型签名

initVision(width: number, height: number, limited?: boolean): void;

入参：

返回

void

redo()

重做白板的上一次被撤销操作

类型签名

redo(): void;

返回

void

undo()

撤销白板的上一次操作

类型签名

undo(): void;

返回

void

reset()

清理白板状态，恢复到初始状态

类型签名

reset(): void;

返回

void

setToolType()

设置工具类型

类型签名

setToolType(insertType: ShapeType): void;

入参：

返回

void

setBackgroundImage()

设置背景图片

类型签名

setBackgroundImage(url: string): any;

入参：

返回

any

setBackgroundImageScalingMode()

设置白板背景图缩放模式

类型签名

setBackgroundImageScalingMode(scaleMode: ImageScalingMode): void;

入参：

返回

void

setCursorSyncType()

设置光标同步类型

类型签名

setCursorSyncType(type: 'write' | 'all'): void;

入参：

返回

void

setRoleType()

设置白板角色类型

类型签名

setRoleType(roleType: WBRoleType): void;

入参：

返回

void

setScale()

设置当前白板视图的缩放比例，范围 0.1 ~ 5

类型签名

setScale(scale: number): void;

入参：

返回

void

snapshot()

截图当前白板内容

类型签名

snapshot(autoDownload?: boolean, mode?: 'all' | 'view', format?: 'png' | 'jpeg', quality?: number): Promise<string>;

入参：

返回

Promise<string>

setBackgroundImageScalingMode()

设置白板背景图缩放模式

类型签名

setBackgroundImageScalingMode(scaleMode: ImageScalingMode): void;

入参：

返回

void

startFollowVision()

开启视角跟随

类型签名

startFollowVision(): void;

返回

void

stopFollowVision()

关闭视角跟随

类型签名

stopFollowVision(): void;

返回

void

startVisionShare()

开启自己的视角共享，将把自己的视角同步给别人，会中其他的用户会收到您的视角跟随邀请

其他用户也可以在您开启视角跟随的情况下开启视角跟随，您的视角跟随将会被终止

通过监听 "user-vision-share-start" 事件来接收别人的视角共享请求

通过监听  "user-vision-share-stop" 事件来接收别人的视角共享取消事件

通过监听 "vision-lock-stop" 事件，当自己作为视角跟随发起者时，视角共享权限被别人抢占时触发该事件

类型签名

startVisionShare(): void;

返回

void

stopVisionShare()

关闭自己的视角锁定，并发消息清除自己的视角resource信息

类型签名

stopVisionShare(): void;

返回

void

switchToDoc()

切换白板文档

类型签名

switchToDoc(docId: string): void;

入参：

返回

void

transcodeFile()

文件转码

类型签名

transcodeFile(params: {
        targetType: 'png' | 'jpg' | 'pdf';
        onUploadProgress?: (state: {
            total: number;
            loaded: number;
        }) => void;
        onTranscodeProgress?: (status: 'init' | 'processing' | 'success' | 'failed') => void;
    }): Promise<{
        pageCount: number;
        url: string[];
        fileName: string;
        docId: string;
    }>;

入参：

返回

Promise<{

pageCount: number;

url: string[];

fileName: string;

docId: string;

}>

setTranslate()

设置画板偏移

类型签名

setTranslate(x: number, y: number, smooth?: boolean, duration?: number): void;

入参：

返回

void

setSelectedShapeFontStyle()

设置当前选中 shape 的 fontStyle

类型签名

setSelectedShapeFontStyle(style: {
        italic?: boolean;
        bold?: boolean;
        fontSize?: number;
    }): void;

入参：

返回

void

setSelectedShapeStyle()

设置当前选中 shape 的 style

类型签名

setSelectedShapeStyle(style: {
        lineWidth?: number;
        strokeStyle?: string;
        fillStyle?: string;
        fillType?: string;
    }): void;

入参：

返回

void

setShapesVisible()

隐藏白板上绘制的轨迹，所有的轨迹都会隐藏，可以控制是否隐藏背景图

类型签名

setShapesVisible(enabled: boolean, hideBackgroundImg?: boolean): void;

入参：

返回

void

setStamp()

选择使用某个图章。选择图章之前，您需要先添加对应图章；

类型签名

setStamp(stampId: string): void;

入参：

返回

void

uploadImage()

上传图片

类型签名

uploadImage(setAsBackground?: boolean, onProgress?: (state: {
        total: number;
        loaded: number;
    }) => void): Promise<void>;

入参：

返回

Promise<void>

uploadPDF()

上传PDF文件

类型签名

uploadPDF(onProgress?: (state: {
        total: number;
        loaded: number;
    }) => void): Promise<{
        url: string;
        fileName: string;
        docId: string;
    }>;

入参：

返回

Promise<{

url: string;

fileName: string;

docId: string;

}>

usePdf()

使用pdf插件

类型签名

static usePdf(plugin: PdfPlugin): void;

入参：

返回

void

updateCanvasSize()

手动调用更新画布 size（一般用于在外部画布容器变化后，主动调用更新画板大小信息）

类型签名

updateCanvasSize: (autoAdjust?: boolean, keepScale?: boolean) => void;

入参：

返回

void

on()

监听一个指定事件并设置回调函数

类型签名

on(event: string, fn: Function): void;

参数

返回

void

off()

取消一个指定事件的监听回调函数

类型签名

off(event: string, fn: Function): void;

参数

返回

void

once()

监听一个指定事件一次，回调函数触发后移除

类型签名

once(event: string, fn: Function): void;

参数

返回

void

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

类型签名

removeAllListeners(event?: string): void;

参数

返回

void

事件详情

"user-join"

用户加入了白板/标注

类型签名

'user-join': (uid: string) => void;

示例

RtcWhiteboard.on('user-join', (uid) => {
 console.log(uid);
});

"user-leave"

用户离开了白板/标注

类型签名

'user-leave': (uid: string) => void;

示例

RtcWhiteboard.on('user-leave', (uid) => {
 console.log(uid);
});

"doc-load-failed"

文档加载失败

类型签名

'doc-load-failed': (docId: string, docName: string) => void;

示例

RtcWhiteboard.on('doc-load-failed', (docId, docName) => {
 console.log(docId, docName);
});

"doc-ready"

文档加载成功

类型签名

'doc-ready': (docId: string) => void;

示例

RtcWhiteboard.on('doc-ready', (docId) => {
 console.log(docId);
});

"user-vision-share-start"

用户视角共享开始

类型签名

'user-vision-share-start': (userId: string) => void;

示例

RtcWhiteboard.on('user-vision-share-start', (userId) => {
 console.log(userId);
});

"vision-lock-stop"

本地视角共享停止

类型签名

'vision-lock-stop': () => void;

示例

RtcWhiteboard.on('vision-lock-stop', () => {
});

"user-vision-share-stop"

用户视角共享结束

类型签名

'user-vision-share-stop': (userId: string) => void;

示例

RtcWhiteboard.on('user-vision-share-stop', (userId) => {
 console.log(userId);
});

"user-vision-share-stop"

用户视角共享结束

类型签名

'user-vision-share-stop': (userId: string) => void;

示例

RtcWhiteboard.on('user-vision-share-stop', (userId) => {
 console.log(userId);
});

"viewport-updated"

视图窗口变化

类型签名

'viewport-updated': (
    scale: number,
    viewport: {
      minx: number;
      miny: number;
      maxx: number;
      maxy: number;
    },
  ) => void;

示例

RtcWhiteboard.on('viewport-updated', (scale, viewport) => {
 console.log(scale, viewport);
});

"doc-switched"

文档已切换

类型签名

'doc-switched': (docId: string) => void;

示例

RtcWhiteboard.on('doc-switched', (docId) => {
 console.log(docId);
});

"doc-created"

新增文档

类型签名

'doc-created': (docId: string) => void;

示例

RtcWhiteboard.on('doc-created', (docId) => {
 console.log(docId);
});

"doc-deleted"

文档已删除

类型签名

'doc-deleted': (userId: string) => void;

示例

RtcWhiteboard.on('doc-deleted', (userId) => {
 console.log(userId);
});

"background-image-updated"

背景图片更新

类型签名

  'background-image-updated': (docId: string, pageIndex: number, imgUrl: string) => void;

示例

RtcWhiteboard.on('background-image-updated', (docId) => {
 console.log(docId);
});

"page-index-changed"

文档页码变化

类型签名

'page-index-changed': (activeDocId: string, pageIndex: number, totalPages: number) => void;

示例

RtcWhiteboard.on('page-index-changed', (docId) => {
 console.log(docId);
});

"viewport-updated-by-self"

视图窗口变化

类型签名

'viewport-updated-by-self': () => void;

示例

RtcWhiteboard.on('viewport-updated-by-self', () => {
});

"history-changed"

undo或者redo记录变化时触发

类型签名

'history-changed': (canUndo: boolean, canRedo: boolean) => void;

示例

RtcWhiteboard.on('history-changed', (canUndo, canRedo) => {
 console.log(canUndo, canRedo);
});