Search

Search something to see results

GitHub

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 {
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    composed: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    eventPhase: number;
    isTrusted: boolean;
    returnValue: boolean;
    srcElement: null | EventTarget;
    target: null | EventTarget;
    timeStamp: number;
    type: string;
    composedPath(): EventTarget[];
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
    NONE: 0;
    CAPTURING_PHASE: 1;
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    altKey: boolean;
    button: number;
    buttons: number;
    clientX: number;
    clientY: number;
    ctrlKey: boolean;
    layerX: number;
    layerY: number;
    metaKey: boolean;
    movementX: number;
    movementY: number;
    offsetX: number;
    offsetY: number;
    pageX: number;
    pageY: number;
    relatedTarget: null | EventTarget;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    x: number;
    y: number;
    getModifierState(keyArg: string): boolean;
    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: null | EventTarget,
    ): void;
    altitudeAngle: number;
    azimuthAngle: number;
    height: number;
    isPrimary: boolean;
    pointerId: number;
    pointerType: string;
    pressure: number;
    tangentialPressure: number;
    tiltX: number;
    tiltY: number;
    twist: number;
    width: number;
    getCoalescedEvents(): PointerEvent[];
    getPredictedEvents(): PointerEvent[];
    detail: number;
    view: null | Window;
    which: number;
    initUIEvent(
        typeArg: string,
        bubblesArg?: boolean,
        cancelableArg?: boolean,
        viewArg?: null | Window,
        detailArg?: number,
    ): void;
}

Hierarchy (View Summary)

Index

Properties

<internal>.PointerEvent.bubbles<internal>.PointerEvent.cancelBubble<internal>.PointerEvent.cancelable<internal>.PointerEvent.composed<internal>.PointerEvent.currentTarget<internal>.PointerEvent.defaultPrevented<internal>.PointerEvent.eventPhase<internal>.PointerEvent.isTrusted<internal>.PointerEvent.returnValue<internal>.PointerEvent.srcElement<internal>.PointerEvent.target<internal>.PointerEvent.timeStamp<internal>.PointerEvent.type<internal>.PointerEvent.NONE<internal>.PointerEvent.CAPTURING_PHASE<internal>.PointerEvent.AT_TARGET<internal>.PointerEvent.BUBBLING_PHASE<internal>.PointerEvent.altKey<internal>.PointerEvent.button<internal>.PointerEvent.buttons<internal>.PointerEvent.clientX<internal>.PointerEvent.clientY<internal>.PointerEvent.ctrlKey<internal>.PointerEvent.layerX<internal>.PointerEvent.layerY<internal>.PointerEvent.metaKey<internal>.PointerEvent.movementX<internal>.PointerEvent.movementY<internal>.PointerEvent.offsetX<internal>.PointerEvent.offsetY<internal>.PointerEvent.pageX<internal>.PointerEvent.pageY<internal>.PointerEvent.relatedTarget<internal>.PointerEvent.screenX<internal>.PointerEvent.screenY<internal>.PointerEvent.shiftKey<internal>.PointerEvent.x<internal>.PointerEvent.y<internal>.PointerEvent.altitudeAngle<internal>.PointerEvent.azimuthAngle<internal>.PointerEvent.height<internal>.PointerEvent.isPrimary<internal>.PointerEvent.pointerId<internal>.PointerEvent.pointerType<internal>.PointerEvent.pressure<internal>.PointerEvent.tangentialPressure<internal>.PointerEvent.tiltX<internal>.PointerEvent.tiltY<internal>.PointerEvent.twist<internal>.PointerEvent.width<internal>.PointerEvent.detail<internal>.PointerEvent.view<internal>.PointerEvent.which

Methods

<internal>.PointerEvent.composedPath<internal>.PointerEvent.initEvent<internal>.PointerEvent.preventDefault<internal>.PointerEvent.stopImmediatePropagation<internal>.PointerEvent.stopPropagation<internal>.PointerEvent.getModifierState<internal>.PointerEvent.initMouseEvent<internal>.PointerEvent.getCoalescedEvents<internal>.PointerEvent.getPredictedEvents<internal>.PointerEvent.initUIEvent

Properties

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

cancelBubble: boolean

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

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

currentTarget: null | 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

eventPhase: number

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

MDN Reference

isTrusted: boolean

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

MDN Reference

returnValue: boolean

MDN Reference

srcElement: null | EventTarget

MDN Reference

target: null | EventTarget

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

MDN Reference

timeStamp: number

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

MDN Reference

type: string

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

MDN Reference

NONE: 0
CAPTURING_PHASE: 1
AT_TARGET: 2
BUBBLING_PHASE: 3
altKey: boolean

MDN Reference

button: number

MDN Reference

buttons: number

MDN Reference

clientX: number

MDN Reference

clientY: number

MDN Reference

ctrlKey: boolean

MDN Reference

layerX: number

MDN Reference

layerY: number

MDN Reference

metaKey: boolean

MDN Reference

movementX: number

MDN Reference

movementY: number

MDN Reference

offsetX: number

MDN Reference

offsetY: number

MDN Reference

pageX: number

MDN Reference

pageY: number

MDN Reference

relatedTarget: null | EventTarget

MDN Reference

screenX: number

MDN Reference

screenY: number

MDN Reference

shiftKey: boolean

MDN Reference

x: number

MDN Reference

y: number

MDN Reference

altitudeAngle: number

MDN Reference

azimuthAngle: number

MDN Reference

height: number

MDN Reference

isPrimary: boolean

MDN Reference

pointerId: number

MDN Reference

pointerType: string

MDN Reference

pressure: number

MDN Reference

tangentialPressure: number

MDN Reference

tiltX: number

MDN Reference

tiltY: number

MDN Reference

twist: number

MDN Reference

width: number

MDN Reference

detail: number

MDN Reference

view: null | Window

MDN Reference

which: number

MDN Reference

Methods

composedPath(): EventTarget[]

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[]

initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void

Parameters

  • type: string
  • Optionalbubbles: boolean
  • Optionalcancelable: boolean

Returns void

MDN Reference

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.

MDN Reference

Returns void

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.

MDN Reference

Returns void

stopPropagation(): void

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

MDN Reference

Returns void

getModifierState(keyArg: string): boolean

MDN Reference

Parameters

  • keyArg: string

Returns boolean

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: null | EventTarget,
): 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: null | EventTarget

Returns void

MDN Reference

getCoalescedEvents(): PointerEvent[]

Available only in secure contexts.

MDN Reference

Returns PointerEvent[]

getPredictedEvents(): PointerEvent[]

MDN Reference

Returns PointerEvent[]

initUIEvent(
    typeArg: string,
    bubblesArg?: boolean,
    cancelableArg?: boolean,
    viewArg?: null | Window,
    detailArg?: number,
): void

Parameters

  • typeArg: string
  • OptionalbubblesArg: boolean
  • OptionalcancelableArg: boolean
  • OptionalviewArg: null | Window
  • OptionaldetailArg: number

Returns void

MDN Reference