Join us online - 19th of November
Save your spot

Interface PointerEvent

The PointerEvent interface represents 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 {
    altitudeAngle: number;
    altKey: boolean;
    AT_TARGET: 2;
    azimuthAngle: number;
    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: EventTarget | null;
    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;
    persistentDeviceId: number;
    pointerId: number;
    pointerType: string;
    pressure: number;
    relatedTarget: EventTarget | null;
    returnValue: boolean;
    screenX: number;
    screenY: number;
    shiftKey: boolean;
    srcElement: EventTarget | null;
    tangentialPressure: number;
    target: EventTarget | null;
    tiltX: number;
    tiltY: number;
    timeStamp: number;
    twist: number;
    type: string;
    view: Window | null;
    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: EventTarget | null,
    ): void;
    initUIEvent(
        typeArg: string,
        bubblesArg?: boolean,
        cancelableArg?: boolean,
        viewArg?: Window | null,
        detailArg?: number,
    ): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy (View Summary)

Index
altitudeAngle altKey AT_TARGET azimuthAngle 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 persistentDeviceId pointerId pointerType pressure relatedTarget returnValue screenX screenY shiftKey srcElement tangentialPressure target tiltX tiltY timeStamp twist type view which width x y
composedPath getCoalescedEvents getModifierState getPredictedEvents initEvent initMouseEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation
altitudeAngle: number

The altitudeAngle read-only property of the PointerEvent interface represents the angle between a transducer (a pointer or stylus) axis and the X-Y plane of a device screen. The altitude angle describes whether the transducer is perpendicular to the screen, parallel, or at some angle in between.

MDN Reference

altKey: boolean

The MouseEvent.altKey read-only property is a boolean value that indicates whether the alt key was pressed or not when a given mouse event occurs.

MDN Reference

AT_TARGET: 2
azimuthAngle: number

The azimuthAngle read-only property of the PointerEvent interface represents the angle between the Y-Z plane and the plane containing both the transducer (pointer or stylus) axis and the Y axis.

MDN Reference

bubbles: boolean

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

BUBBLING_PHASE: 3
button: number

The MouseEvent.button read-only property indicates which button was pressed or released on the mouse to trigger the event.

MDN Reference

buttons: number

The MouseEvent.buttons read-only property indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.

MDN Reference

cancelable: boolean

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

cancelBubble: boolean

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

MDN Reference

CAPTURING_PHASE: 1
clientX: number

The clientX read-only property of the MouseEvent interface provides the horizontal coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

clientY: number

The clientY read-only property of the MouseEvent interface provides the vertical coordinate within the application's viewport at which the event occurred (as opposed to the coordinate within the page).

MDN Reference

composed: boolean

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

ctrlKey: boolean

The MouseEvent.ctrlKey read-only property is a boolean value that indicates whether the ctrl key was pressed or not when a given mouse event occurs.

MDN Reference

currentTarget: EventTarget | null

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

defaultPrevented: boolean

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

detail: number

The UIEvent.detail read-only property, when non-zero, provides the current (or next, depending on the event) click count.

MDN Reference

eventPhase: number

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

MDN Reference

height: number

The height read-only property of the PointerEvent interface represents the height of the pointer's contact geometry, along the y-axis (in CSS pixels). Depending on the source of the pointer device (for example a finger), for a given pointer, each event may produce a different value.

MDN Reference

isPrimary: boolean

The isPrimary read-only property of the PointerEvent interface indicates whether or not the pointer device that created the event is the primary pointer. It returns true if the pointer that caused the event to be fired is the primary one and returns false otherwise.

MDN Reference

isTrusted: boolean

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

layerX: number

The MouseEvent.layerX read-only property returns the horizontal coordinate of the event relative to the current layer.

MDN Reference

layerY: number

The MouseEvent.layerY read-only property returns the vertical coordinate of the event relative to the current layer.

MDN Reference

metaKey: boolean

The MouseEvent.metaKey read-only property is a boolean value that indicates whether the meta key was pressed or not when a given mouse event occurs.

MDN Reference

movementX: number

The movementX read-only property of the MouseEvent interface provides the difference in the X coordinate of the mouse (or pointer) between the given move event and the previous move event of the same type.

MDN Reference

movementY: number

The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse (or pointer) between the given move event and the previous move event of the same type.

MDN Reference

NONE: 0
offsetX: number

The offsetX read-only property of the MouseEvent interface provides the offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

offsetY: number

The offsetY read-only property of the MouseEvent interface provides the offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.

MDN Reference

pageX: number

The pageX read-only property of the MouseEvent interface returns the X (horizontal) coordinate (in pixels) at which the mouse was clicked, relative to the left edge of the entire document. This includes any portion of the document not currently visible.

MDN Reference

pageY: number

The pageY read-only property of the MouseEvent interface returns the Y (vertical) coordinate (in pixels) at which the mouse was clicked, relative to the top edge of the entire document. This includes any portion of the document not currently visible.

MDN Reference

persistentDeviceId: number

The persistentDeviceId read-only property of the PointerEvent interface is a unique identifier for the pointing device generating the PointerEvent. This provides a secure, reliable way to identify multiple pointing devices (such as pens) interacting with the screen simultaneously.

MDN Reference

pointerId: number

The pointerId read-only property of the PointerEvent interface is an identifier assigned to the pointer that triggered the event. The identifier is unique, being different from the identifiers of all other active pointer events.

MDN Reference

pointerType: string

The pointerType read-only property of the PointerEvent interface indicates the device type (mouse, pen, or touch) that caused a given pointer event.

MDN Reference

pressure: number

The pressure read-only property of the PointerEvent interface indicates the normalized pressure of the pointer input.

MDN Reference

relatedTarget: EventTarget | null

The MouseEvent.relatedTarget read-only property is the secondary target for the mouse event, if there is one.

MDN Reference

returnValue: boolean

The Event property returnValue indicates whether the default action for this event has been prevented or not.

MDN Reference

screenX: number

The screenX read-only property of the MouseEvent interface provides the horizontal coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

screenY: number

The screenY read-only property of the MouseEvent interface provides the vertical coordinate (offset) of the mouse pointer in screen coordinates.

MDN Reference

shiftKey: boolean

The MouseEvent.shiftKey read-only property is a boolean value that indicates whether the shift key was pressed or not when a given mouse event occurs.

MDN Reference

srcElement: EventTarget | null

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

MDN Reference

tangentialPressure: number

The tangentialPressure read-only property of the PointerEvent interface represents the normalized tangential pressure of the pointer input (also known as barrel pressure or cylinder stress).

MDN Reference

target: EventTarget | null

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

MDN Reference

tiltX: number

The tiltX read-only property of the PointerEvent interface is the angle (in degrees) between the Y-Z plane of the pointer and the screen. This property is typically only useful for a pen/stylus pointer type.

MDN Reference

tiltY: number

The tiltY read-only property of the PointerEvent interface is the angle (in degrees) between the X-Z plane of the pointer and the screen. This property is typically only useful for a pen/stylus pointer type.

MDN Reference

timeStamp: number

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

twist: number

The twist read-only property of the PointerEvent interface represents the clockwise rotation of the pointer (e.g., pen stylus) around its major axis, in degrees.

MDN Reference

type: string

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

MDN Reference

view: Window | null

The UIEvent.view read-only property returns the WindowProxy object from which the event was generated. In browsers, this is the Window object the event happened in.

MDN Reference

which: number

The UIEvent.which read-only property of the UIEvent interface returns a number that indicates which button was pressed on the mouse, or the numeric keyCode or the character code (charCode) of the key pressed on the keyboard.

MDN Reference

width: number

The width read-only property of the PointerEvent interface represents the width of the pointer's contact geometry along the x-axis, measured in CSS pixels. Depending on the source of the pointer device (such as a finger), for a given pointer, each event may produce a different value.

MDN Reference

x: number

The MouseEvent.x property is an alias for the MouseEvent.clientX property.

MDN Reference

y: number

The MouseEvent.y property is an alias for the MouseEvent.clientY property.

MDN Reference

  • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

    MDN Reference

    Returns EventTarget[]

  • The getCoalescedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that were coalesced (merged) into a single pointermove or pointerrawupdate event. Instead of a stream of many pointermove events, user agents coalesce multiple updates into a single event. This helps with performance as the user agent has less event handling to perform, but there is a reduction in the granularity and accuracy when tracking, especially with fast and large movements. Available only in secure contexts.

    MDN Reference

    Returns PointerEvent[]

  • The MouseEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (i.e., the modifier key is pressed or locked), otherwise, false.

    MDN Reference

    Parameters

    • keyArg: string

    Returns boolean

  • The getPredictedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that are estimated future pointer positions. How the predicted positions are calculated depends on the user agent, but they are based on past points, current velocity, and trajectory.

    MDN Reference

    Returns PointerEvent[]

  • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

    Parameters

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

    Returns void

    MDN Reference

  • The MouseEvent.initMouseEvent() method initializes the value of a mouse event once it's been created (normally using the Document.createEvent() method).

    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

    MDN Reference

  • The UIEvent.initUIEvent() method initializes a UI event once it's been created.

    Parameters

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

    Returns void

    MDN Reference

  • The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

    MDN Reference

    Returns void

  • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

    MDN Reference

    Returns void

Was this helpful?