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

Hierarchy (view full)

Properties

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

Methods

composedPath getCoalescedEvents getModifierState getPredictedEvents initEvent initMouseEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

Properties

ReadonlyaltKey

altKey: boolean

MDN Reference

ReadonlyAT_TARGET

AT_TARGET

Readonlybubbles

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

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE

Readonlybutton

button: number

MDN Reference

Readonlybuttons

buttons: number

MDN Reference

Readonlycancelable

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

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE

ReadonlyclientX

clientX: number

MDN Reference

ReadonlyclientY

clientY: number

MDN Reference

Readonlycomposed

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

ReadonlyctrlKey

ctrlKey: boolean

MDN Reference

ReadonlycurrentTarget

currentTarget: null | EventTarget

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

MDN Reference

ReadonlydefaultPrevented

defaultPrevented: boolean

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

MDN Reference

Readonlydetail

detail: number

MDN Reference

ReadonlyeventPhase

eventPhase: number

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

MDN Reference

Readonlyheight

height: number

MDN Reference

ReadonlyisPrimary

isPrimary: boolean

MDN Reference

ReadonlyisTrusted

isTrusted: boolean

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

MDN Reference

ReadonlylayerX

layerX: number

MDN Reference

ReadonlylayerY

layerY: number

MDN Reference

ReadonlymetaKey

metaKey: boolean

MDN Reference

ReadonlymovementX

movementX: number

MDN Reference

ReadonlymovementY

movementY: number

MDN Reference

ReadonlyNONE

NONE

ReadonlyoffsetX

offsetX: number

MDN Reference

ReadonlyoffsetY

offsetY: number

MDN Reference

ReadonlypageX

pageX: number

MDN Reference

ReadonlypageY

pageY: number

MDN Reference

ReadonlypointerId

pointerId: number

MDN Reference

ReadonlypointerType

pointerType: string

MDN Reference

Readonlypressure

pressure: number

MDN Reference

ReadonlyrelatedTarget

relatedTarget: null | EventTarget

MDN Reference

returnValue

returnValue: boolean

Deprecated

MDN Reference

ReadonlyscreenX

screenX: number

MDN Reference

ReadonlyscreenY

screenY: number

MDN Reference

ReadonlyshiftKey

shiftKey: boolean

MDN Reference

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

ReadonlytangentialPressure

tangentialPressure: number

MDN Reference

Readonlytarget

target: null | EventTarget

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

MDN Reference

ReadonlytiltX

tiltX: number

MDN Reference

ReadonlytiltY

tiltY: number

MDN Reference

ReadonlytimeStamp

timeStamp: number

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

MDN Reference

Readonlytwist

twist: number

MDN Reference

Readonlytype

type: string

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

MDN Reference

Readonlyview

view: null | Window

MDN Reference

Readonlywhich

which: number

Deprecated

MDN Reference

Readonlywidth

width: number

MDN Reference

Readonlyx

x: number

MDN Reference

Readonlyy

y: number

MDN Reference

Methods

composedPath

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

getCoalescedEvents

getModifierState

getPredictedEvents

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

initMouseEvent

  • initMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg): 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

    Deprecated

    MDN Reference

initUIEvent

  • initUIEvent(typeArg, bubblesArg?, cancelableArg?, viewArg?, detailArg?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

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.

    MDN Reference

    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.

    MDN Reference

    Returns void

stopPropagation

  • 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

Settings

Member Visibility

On This Page

Properties
Methods