Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CursorAdapter

Sets the cursor adaptor.

Hierarchy

  • CursorAdapter

Index

Properties

Methods

Properties

onAddedCursor

onAddedCursor: ((cursor: Cursor) => void) | undefined

Occurs when the cursor appears on the whiteboard.

param

The cursor object.

onMovingCursor

onMovingCursor: ((cursor: Cursor, positionX: number, positionY: number) => void) | undefined

Occurs when the cursor moves on the whiteboard.

param

The cursor object.

param

The X coordinate of the center of the area the cursor is pointing to (taking the upper left corner of the initial whiteboard as the origin).

param

The Y coordinate of the center of the area the cursor is pointing to (taking the upper left corner of the initial whiteboard as the origin).

onRemovedCursor

onRemovedCursor: ((cursor: Cursor) => void) | undefined

Occurs when the cursor disappears from the whiteboard.

param

The cursor object.

Methods

createCursor

  • Creates the cursor description. This method is called before the user's cursor appears for the first time.

    Parameters

    • memberId: number

      The ID of the user.

    Returns CursorDescription & { reactNode?: any }

    Description of the user's cursor.