Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PointerEvent

Package version

The state of a DOM event produced by a pointer such as the geometry of the contact point, the device type that generated the event, the amount of pressure that was applied on the contact surface, etc.

Hierarchy

Index

Properties

AT_TARGET

AT_TARGET: number

BUBBLING_PHASE

BUBBLING_PHASE: number

CAPTURING_PHASE

CAPTURING_PHASE: number

MouseEvent

MouseEvent: { constructor: any; prototype: MouseEvent }

Type declaration

  • constructor: function
    • Parameters

      Returns MouseEvent

  • prototype: MouseEvent

NONE

NONE: number

altKey

altKey: boolean

bubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

button

button: number

buttons

buttons: number

cancelBubble

cancelBubble: boolean

cancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

clientX

clientX: number

clientY

clientY: number

composed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

ctrlKey

ctrlKey: boolean

currentTarget

currentTarget: EventTarget | null

Returns the object whose event listener's callback is currently being invoked.

defaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

detail

detail: number

eventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

height

height: number

isPrimary

isPrimary: boolean

isTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

metaKey

metaKey: boolean

movementX

movementX: number

movementY

movementY: number

offsetX

offsetX: number

offsetY

offsetY: number

pageX

pageX: number

pageY

pageY: number

pointerId

pointerId: number

pointerType

pointerType: string

pressure

pressure: number

relatedTarget

relatedTarget: EventTarget | null

returnValue

returnValue: boolean

screenX

screenX: number

screenY

screenY: number

shiftKey

shiftKey: boolean

srcElement

srcElement: EventTarget | null
deprecated

tangentialPressure

tangentialPressure: number

target

target: EventTarget | null

Returns the object to which event is dispatched (its target).

tiltX

tiltX: number

tiltY

tiltY: number

timeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

twist

twist: number

type

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

view

view: Window | null

which

which: number
deprecated

width

width: number

x

x: number

y

y: number

Methods

composedPath

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    Returns EventTarget[]

getModifierState

  • getModifierState(keyArg: string): boolean
  • Parameters

    • keyArg: string

    Returns boolean

initEvent

  • initEvent(type: string, bubbles?: undefined | false | true, cancelable?: undefined | false | true): void
  • Parameters

    • type: string
    • Optional bubbles: undefined | false | true
    • Optional cancelable: undefined | false | true

    Returns void

initMouseEvent

  • initMouseEvent(typeArg: string, canBubbleArg: boolean, cancelableArg: boolean, viewArg: Window, detailArg: number, screenXArg: number, screenYArg: number, clientXArg: number, clientYArg: number, ctrlKeyArg: boolean, altKeyArg: boolean, shiftKeyArg: boolean, metaKeyArg: boolean, buttonArg: number, relatedTargetArg: EventTarget | null): void
  • Parameters

    • typeArg: string
    • canBubbleArg: boolean
    • cancelableArg: boolean
    • viewArg: Window
    • detailArg: number
    • screenXArg: number
    • screenYArg: number
    • clientXArg: number
    • clientYArg: number
    • ctrlKeyArg: boolean
    • altKeyArg: boolean
    • shiftKeyArg: boolean
    • metaKeyArg: boolean
    • buttonArg: number
    • relatedTargetArg: EventTarget | null

    Returns void

preventDefault

  • preventDefault(): void
  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void
  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    Returns void

stopPropagation

  • stopPropagation(): void
  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Generated using TypeDoc