TLPointer

Extends BaseRecord<'pointer', TLPointerId>.

Represents the current pointer/cursor position and activity state. This record tracks the mouse or touch pointer coordinates and when the pointer was last active, useful for cursor synchronization in collaborative environments.

There is typically one pointer record per browser tab that gets updated as the user moves their mouse or touches the screen.

interface TLPointer extends BaseRecord<'pointer', TLPointerId> {}

Example

const pointer: TLPointer = {
  id: 'pointer:pointer',
  typeName: 'pointer',
  x: 150,
  y: 200,
  lastActivityTimestamp: Date.now(),
  meta: {},
}

Properties

readonly id: Id

lastActivityTimestamp: number

meta: JsonObject

readonly typeName: TypeName

x: number

y: number