Interface IPointersStaticProps

interface IPointersStaticProps {
    __staticProp?: true;
    buttons?: number[] | (type: TPointersType) => number[];
    container: HTMLElement | SVGElement;
    disableUserSelect?: boolean;
    maxPointers?: number | (type: TPointersType) => number;
    minPointers?: number | (type: TPointersType) => number;
    relative?: boolean;
}

Hierarchy (View Summary)

Properties

__staticProp? buttons? container disableUserSelect? maxPointers? minPointers? relative?

Properties

Optional__staticProp

__staticProp?: true

Optionalbuttons

buttons?: number[] | (type: TPointersType) => number[]

Determines which mouse buttons trigger events.

  • 0: Main button pressed, usually the left button or the un-initialized state
  • 1: Auxiliary button pressed, usually the wheel button or the middle button (if present)
  • 2: Secondary button pressed, usually the right button
  • 3: Fourth button, typically the Browser Back button
  • 4: Fifth button, typically the Browser Forward button

See MouseEvent.button.

Default

[0]

container

container: HTMLElement | SVGElement

The element that listens for pointer events.

Ensure the element has the appropriate touch-action property to prevent conflicts with browser gestures.

OptionaldisableUserSelect

disableUserSelect?: boolean

Prevent text selection during a mouse gesture.

Default

true

OptionalmaxPointers

maxPointers?: number | (type: TPointersType) => number

Maximum number of pointers that can be tracked simultaneously.

Default

5

OptionalminPointers

minPointers?: number | (type: TPointersType) => number

Minimum number of active pointers required to trigger the "start" callback.

Default

1

Optionalrelative

relative?: boolean

Calculate coordinates relative to the container.

Default

false

Settings

Member Visibility

On This Page

Properties