Chartbreaker
    Preparing search index...

    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: 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 Summary)

    Index

    Properties

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

    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.

    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.

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

    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 being evaluated.

    MDN Reference

    height: number

    The height read-only property of the geometry, along the y-axis (in CSS pixels).

    MDN Reference

    isPrimary: boolean

    The isPrimary read-only property of the created the event is the primary pointer.

    MDN Reference

    isTrusted: boolean

    The isTrusted read-only property of the 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 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 pointer between the given event and the previous Element/mousemove_event event.

    MDN Reference

    movementY: number

    The movementY read-only property of the MouseEvent interface provides the difference in the Y coordinate of the mouse pointer between the given event and the previous Element/mousemove_event event.

    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.

    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.

    MDN Reference

    pointerId: number

    The pointerId read-only property of the event.

    MDN Reference

    pointerType: string

    The pointerType read-only property of the that caused a given pointer event.

    MDN Reference

    pressure: number

    The pressure read-only property of the input.

    MDN Reference

    relatedTarget: null | EventTarget

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

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

    MDN Reference

    tangentialPressure: number

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

    MDN Reference

    target: null | EventTarget

    The read-only target property of the dispatched.

    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.

    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.

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

    MDN Reference

    view: null | Window

    The UIEvent.view read-only property returns the 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 geometry along the x-axis, measured in CSS pixels.

    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

    Methods

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

      MDN Reference

      Returns EventTarget[]

    • The getCoalescedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that were coalesced (merged) into a single Element/pointermove_event or Element/pointerrawupdate_event event. 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.

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

      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: null | Window
      • OptionaldetailArg: number

      Returns void

      MDN Reference

    • The preventDefault() method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

      MDN Reference

      Returns void

    • The stopImmediatePropagation() method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.

      MDN Reference

      Returns void

    • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

      MDN Reference

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods