export declare enum XYArtboardKind { 'WHITE_BOARD' = "WHITE_BOARD", 'ANNOTATION' = "ANNOTATION", 'UNKNOWN' = "UNKNOWN" } export declare enum XYArtboardAction { 'START' = "start", 'STOP' = "stop" } /** * 白板状态 * * @property { XYArtboardAction } action - 白板动作 * @property { string } ownerName - 白板发起者名称 * @property { string } ownerUri - 白板发起者uri * @property { string } url - 白板url * @property { boolean } connected - 白板服务是否已链接 */ export interface XYWhiteboardState { action: XYArtboardAction; ownerName: string; ownerUri: string; url: string; connected?: boolean; } /** * 批注状态 * * @property { string } globalCode - 批注全局唯一标识 * @property { string } reason - 批注原因 * @property { boolean } start - 批注状态 * @property { string } state - 批注状态 * @property { string } url - 批注url */ export interface XYAnnotationState { globalCode: string; reason: string; start: boolean; state: string; url: string; } /** * 白板命令类型 * * @param DRAW_LINE 1 - 绘制 * @param CLEAR_LINES 2 - 清除 * @param GET_LINES 3 - 获取某一页的所有消息 * @param UNDO_LINE 4 - 回退 * @param REDO_LINE 5 - 重做 * @param GRAPH_LINE 13 - 三角形,矩形,圆形,直线,箭头 * @param BACKGROUND_COLOR 14 - 背景色 * @param ERASER_WHOLE_LINE 15 - 擦除一整条线 */ export declare enum XY_WHITEBOARD_TYPE { /** * 1绘制线条 */ DRAW_LINE = 1, /** * 2清除 */ CLEAR_LINES = 2, /** * 3获取某一页的所有消息 */ GET_LINES = 3, /** * 4上一步 */ UNDO_LINE = 4, /** * 5下一步 */ REDO_LINE = 5, /** * 6获取所有页 */ GET_PAGES = 6, /** * 7返回所有页信息和当前页 */ PAGE_LIST = 7, /** * 8获取某一页的所有线 */ GET_LINES_IN_PAGE = 8, /** * 恢复注解 */ RESUME_ANNOTATION = 9, /** * 暂停注解 */ PAUSE_ANNOTATION = 10, /** * 获取当前注解状态 */ GET_ANNOTATION_STATUS = 11, /** * 12告诉发送方线条已收到 */ RECEIVE_LINE_ANNOTATION = 12, /** * 13三角形,矩形,圆形,直线,箭头 */ GRAPH_LINE = 13, /** * 14背景色 */ BACKGROUND_COLOR = 14, /** * 15擦除一整条线 */ ERASER_WHOLE_LINE = 15, /** * 16多页切换消息 */ SWITCH_PAGE = 16, /** * 17编辑消息 */ EDIT_LINE = 17, /** * 18增加页 */ ADD_PAGE = 18, /** * 19删除页 */ DELETE_PAGE = 19 } export declare enum XY_WHITEBORAD_OPERATE { /** * 清空所有、本地、远端 */ CLEAR = "CLEAR", /** * 删除,data中的cids可能是一组数据 */ DELETE = "DELETE", /** * 绘画一组 */ DRAW = "DRAW", /** * 编辑 */ EDIT = "EDIT", UNKNOWN = "UNKNOWN" } export declare enum XY_WHITEBOARD_STATE { NORMAL = "NORMAL", CACHE_START = "CACHE_START", CACHE_END = "CACHE_END" } export interface XY_WHITEBOARD_EVENT_DATA { data?: XY_WHITEBOARD_DATA; state?: XY_WHITEBOARD_STATE; } /** * 清除权限 * * @param ALL 0 - 清除所有人的绘制内容 * @param OWNER 1 - 清除自己的绘制内容 * @param OTHER 2 - 清除他人的绘制内容 */ export declare enum XY_WHITEBOARD_LIMIT { ALL = 0, OWNER = 1, OTHER = 2 } /** * 图形类型 * * @param TRIANGLE 1 - 三角形 * @param RECT 2 - 矩形 * @param CIRCLE 3 - 圆形 * @param LINE 4 - 直线 * @param ARROW 5 - 箭头 */ export declare enum XY_WHITEBOARD_SHAPE { TRIANGLE = 1, RECT = 2, CIRCLE = 3, LINE = 4, ARROW = 5 } /** * 白板绘制数据 * * @property { number } x - x坐标 * @property { number } y - y坐标 * @property { string } c - 颜色, 线条颜色ARGB格式,如:#7f7f00ff * @property { number } w - 线条宽度, 当w大于0代表起始点,w等于0代表结束点,移动点没有c和w */ export interface XY_WHITEBOARD_DRAWER_DATA { x: number; y: number; c?: string; w?: number; } /** * 当前页面信息 * * @property { string } color - 背景色 * @property { number } media - 白板类型,1:白板 2:桌面共享 * @property { number } pageId - 页面id * @property { string } prop - 该白板的标准尺寸和其他属性。如果值为空字符串,则有服务器指定 * @property { number } seq - 线的序列号 */ export interface XY_WHITEBOARD_PAGE_DATA { color: string; media: number; pageId: number; prop: string; seq: number; url: string; } /** * 白板消息 * * @property { XY_WHITEBOARD_TYPE } type - 命令类型 * @property { number } pageId - [optional],pageId由什么生成 * @property { string } cid - 操作唯一标识 * @property { number } oldCid - 编辑消息时提供的唯一标识,匹配后需要替换为cid字段 * @property { string[] } cids - 删除线的cid,数组列表,可能包含多条线条数据 * @property { XY_WHITEBOARD_LIMIT } limit - 清除权限 * @property { XY_WHITEBOARD_SHAPE } shape - 图形 * @property { XY_WHITEBOARD_DRAWER_DATA[] } p - 白板详细绘制数据 * @property { number } c - 是否有缓存消息;仅白板有用,当前页索引("p"对应list的索引),我们会根据这个索引找到"p"中对应的页面信息 * @property { string } id - 用户ID * @property { string } seq - 操作索引位 * @property { boolean } enable - 此条画板或者操作数据是否启用,默认true,代表可用 * @property { string } name - 用户名称 * @property { number } f - 编辑线条时的起始和结束标志位,其中f=0代表开始,f=1代表结束,在此期间seq值不变,需要合并作为一次操作行为,具备撤销和重做功能 * @property { XY_WHITEBOARD_DATA[] } list - 编辑线条的数据集合 * */ export interface XY_WHITEBOARD_DATA { type: XY_WHITEBOARD_TYPE; cids?: string[]; cid?: string; oldCid?: string; pageId?: number; limit?: XY_WHITEBOARD_LIMIT; shape?: XY_WHITEBOARD_SHAPE; p?: XY_WHITEBOARD_DRAWER_DATA[] | XY_WHITEBOARD_PAGE_DATA[]; c?: number; id?: string; seq?: number; enable?: boolean; name?: string; f?: number; list?: XY_WHITEBOARD_DATA[]; media?: number; url?: string; prop?: string; color?: string; } export interface XY_CACHE_EDIT { seq: number; f: number; data: XY_WHITEBOARD_DATA[]; }