Interface PointerEvent

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.

MDN Reference

interface PointerEvent {
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    CAPTURING_PHASE: 1;
    NONE: 0;
    altKey: boolean;
    bubbles: boolean;
    button: number;
    buttons: number;
    cancelBubble: boolean;
    cancelable: boolean;
    clientX: number;
    clientY: number;
    composed: boolean;
    ctrlKey: boolean;
    currentTarget: EventTarget;
    defaultPrevented: boolean;
    detail: number;
    eventPhase: number;
    height: number;
    isPrimary: boolean;
    isTrusted: boolean;
    metaKey: boolean;
    movementX: number;
    movementY: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    pointerId: number;
    pointerType: string;
    pressure: number;
    relatedTarget: EventTarget;
    returnValue: boolean;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    srcElement: EventTarget;
    tangentialPressure: number;
    target: EventTarget;
    tiltX: number;
    tiltY: number;
    timeStamp: number;
    twist: number;
    type: string;
    view: Window;
    which: number;
    width: number;
    x: number;
    y: number;
    composedPath(): EventTarget[];
    getCoalescedEvents(): PointerEvent[];
    getModifierState(keyArg): boolean;
    getPredictedEvents(): PointerEvent[];
    initEvent(type, bubbles?, cancelable?): void;
    initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): void;
    initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (view full)

Properties

AT_TARGET: 2
BUBBLING_PHASE: 3
CAPTURING_PHASE: 1
NONE: 0
altKey: boolean
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.

MDN Reference

button: number
buttons: number
cancelBubble: boolean

Deprecated

MDN Reference

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.

MDN Reference

clientX: number
clientY: number
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.

MDN Reference

ctrlKey: boolean
currentTarget: EventTarget

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

MDN Reference

defaultPrevented: boolean

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

MDN Reference

detail: number
eventPhase: number

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

MDN Reference

height: number
isPrimary: boolean
isTrusted: boolean

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

MDN Reference

metaKey: boolean
movementX: number
movementY: number
offsetX: number
offsetY: number
pageX: number
pageY: number
pointerId: number
pointerType: string
pressure: number
relatedTarget: EventTarget
returnValue: boolean

Deprecated

MDN Reference

screenX: number
screenY: number
shiftKey: boolean
srcElement: EventTarget

Deprecated

MDN Reference

tangentialPressure: number
target: EventTarget

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

MDN Reference

tiltX: number
tiltY: number
timeStamp: number

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

MDN Reference

twist: number
type: string

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

MDN Reference

view: Window
which: number

Deprecated

MDN Reference

width: number
x: number
y: number

Methods

  • 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.

    MDN Reference

    Returns EventTarget[]

  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

    Deprecated

    MDN Reference

  • 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

    Returns void

    Deprecated

    MDN Reference

  • Parameters

    • typeArg: string
    • Optional bubblesArg: boolean
    • Optional cancelableArg: boolean
    • Optional viewArg: Window
    • Optional detailArg: number

    Returns void

    Deprecated

    MDN Reference

  • 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.

    MDN Reference

    Returns 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.

    MDN Reference

    Returns void

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

    MDN Reference

    Returns void