Accessors

note

All Module accessors are available in this class.

container

Type: HTMLElement | SVGElement

Returns the container element handling events.

const pointers = new Pointers({
  container: document.getElementById('container'),
});

pointers.container; // container element

isStarted

Type: boolean

Indicates whether the start event has been triggered.

const pointers = new Pointers({
  container: document.getElementById('container'),
});

pointers.isStarted; // true or false

maxPointers

Type: number

Returns the maximum number of pointers that can be tracked.

const pointers = new Pointers({
  container: document.getElementById('container'),
});

pointers.maxPointers; // maximum number of pointers

minPointers

Type: number

Returns the minimum number of pointers required to trigger events.

const pointers = new Pointers({
  container: document.getElementById('container'),
});

pointers.minPointers; // minimum number of pointers

pointersMap

Type: Map<number, IPointersItem>

Contains all currently active pointers.
Keys correspond to native pointerId values from Pointer Events API.
Entries are updated every frame and preserved until the pointer is fully released (pointerup / pointercancel).

const pointers = new Pointers({
  container: document.getElementById('container'),
});

pointers.pointersMap; // map of active pointers