vot.js - v2.4.12
    Preparing search index...

    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 {
        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[];
        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;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): 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

    MDN Reference

    altKey: boolean

    MDN Reference

    AT_TARGET: 2
    azimuthAngle: number

    MDN Reference

    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

    BUBBLING_PHASE: 3
    button: number

    MDN Reference

    buttons: number

    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

    cancelBubble: boolean

    MDN Reference

    CAPTURING_PHASE: 1
    clientX: number

    MDN Reference

    clientY: number

    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

    ctrlKey: boolean

    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

    detail: number

    MDN Reference

    eventPhase: number

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

    MDN Reference

    height: number

    MDN Reference

    isPrimary: boolean

    MDN Reference

    isTrusted: boolean

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

    MDN Reference

    layerX: number

    MDN Reference

    layerY: number

    MDN Reference

    metaKey: boolean

    MDN Reference

    movementX: number

    MDN Reference

    movementY: number

    MDN Reference

    NONE: 0
    offsetX: number

    MDN Reference

    offsetY: number

    MDN Reference

    pageX: number

    MDN Reference

    pageY: number

    MDN Reference

    pointerId: number

    MDN Reference

    pointerType: string

    MDN Reference

    pressure: number

    MDN Reference

    relatedTarget: null | EventTarget

    MDN Reference

    returnValue: boolean

    MDN Reference

    screenX: number

    MDN Reference

    screenY: number

    MDN Reference

    shiftKey: boolean

    MDN Reference

    srcElement: null | EventTarget

    MDN Reference

    tangentialPressure: number

    MDN Reference

    target: null | EventTarget

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

    MDN Reference

    tiltX: number

    MDN Reference

    tiltY: number

    MDN Reference

    timeStamp: number

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

    MDN Reference

    twist: number

    MDN Reference

    type: string

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

    MDN Reference

    view: null | Window

    MDN Reference

    which: number

    MDN Reference

    width: number

    MDN Reference

    x: number

    MDN Reference

    y: number

    MDN Reference

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

    • Returns an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness.

      Returns [EventTarget?]

    • Parameters

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

      Returns void

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

      Returns void

      MDN Reference

    • Parameters

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

      Returns void

      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

    • Sets the defaultPrevented property to true if cancelable is true.

      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

    • Stops the invocation of event listeners after the current one completes.

      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

    • This is not used in Node.js and is provided purely for completeness.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods