Cursor

Whiteboard Web SDK 2.16.59 公开 interface。

JavaScript

export declare interface Cursor  

Properties

divElement

readonly divElement: HTMLDivElement;

光标的容器，在创建之初为空。 你可以通过如下代码向容器中添加 HTML 元素，以改变光标的外观。 @example ```typescript const icon = document.createElement("img"); icon.src = "https://my-resources.com/icon.png"; cursor.divElement.append(icon); ```

memberId

readonly memberId: number;

光标所属用户的 ID

eraserSize

readonly eraserSize: number;

当教具是铅笔橡皮时，橡皮的尺寸，值为 1~3

cursorMember

readonly cursorMember: CursorMember;

光标所属用户的一些属性封装

x

readonly x: number;

光标指示中心点的 x 坐标（相对于白板左上角）

y

readonly y: number;

光标指示中心点的 y 坐标（相对于白板左上角）

width

readonly width: number;

光标图形的宽度

height

readonly height: number;

光标图形的高度

onCursorMemberChanged

onCursorMemberChanged: (cursorMember: CursorMember)=>void;

成员 cursorMember 改变后的回调。可以用如下代码监听。 @params cursorMember 更新后的 @example ```typescript cursor.onCursorMemberChanged = function(cursorMember) { // cursorMember 改变了 } ```

Methods

setReactNode

setReactNode(reactNode: any): void;

通过注入 JSX 结构来改变光标的外观。
@param reactNode 描述光标外观的 JSX
@example
tsx{"\n"}cursor.setReactNode({"\n"}{" "}<img src="https://my-resources.com/icon.png"/>{"\n"});{"\n"}

返回值

void

setCursorDescription

setCursorDescription(description: Partial<CursorDescription>): void;

中途修改光标的描述
@param description 光标的描述

返回值

void