Interface WheelEvent

    Events that occur due to the user moving a mouse wheel or similar input device.

    MDN Reference

    interface WheelEvent {
        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: EventTarget;
        defaultPrevented: boolean;
        deltaMode: number;
        deltaX: number;
        deltaY: number;
        deltaZ: number;
        detail: number;
        DOM_DELTA_LINE: 1;
        DOM_DELTA_PAGE: 2;
        DOM_DELTA_PIXEL: 0;
        eventPhase: number;
        isTrusted: boolean;
        layerX: number;
        layerY: number;
        metaKey: boolean;
        movementX: number;
        movementY: number;
        NONE: 0;
        offsetX: number;
        offsetY: number;
        pageX: number;
        pageY: number;
        relatedTarget: EventTarget;
        returnValue: boolean;
        screenX: number;
        screenY: number;
        shiftKey: boolean;
        srcElement: EventTarget;
        target: EventTarget;
        timeStamp: number;
        type: string;
        view: Window;
        which: number;
        x: number;
        y: number;
        composedPath(): EventTarget[];
        getModifierState(keyArg: string): boolean;
        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): void;
        initUIEvent(typeArg: string, bubblesArg?: boolean, cancelableArg?: boolean, viewArg?: Window, detailArg?: number): void;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
    }
    Hierarchy

    Properties

    altKey AT_TARGET bubbles BUBBLING_PHASE button buttons cancelable cancelBubble CAPTURING_PHASE clientX clientY composed ctrlKey currentTarget defaultPrevented deltaMode deltaX deltaY deltaZ detail DOM_DELTA_LINE DOM_DELTA_PAGE DOM_DELTA_PIXEL eventPhase isTrusted layerX layerY metaKey movementX movementY NONE offsetX offsetY pageX pageY relatedTarget returnValue screenX screenY shiftKey srcElement target timeStamp type view which x y

    Methods

    composedPath getModifierState initEvent initMouseEvent initUIEvent preventDefault stopImmediatePropagation stopPropagation

    Properties

    ReadonlyaltKey

    altKey: boolean

    MDN Reference

    ReadonlyAT_TARGET

    AT_TARGET: 2

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

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

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

    ReadonlydeltaMode

    deltaMode: number

    MDN Reference

    ReadonlydeltaX

    deltaX: number

    MDN Reference

    ReadonlydeltaY

    deltaY: number

    MDN Reference

    ReadonlydeltaZ

    deltaZ: number

    MDN Reference

    Readonlydetail

    detail: number

    MDN Reference

    ReadonlyDOM_DELTA_LINE

    DOM_DELTA_LINE: 1

    ReadonlyDOM_DELTA_PAGE

    DOM_DELTA_PAGE: 2

    ReadonlyDOM_DELTA_PIXEL

    DOM_DELTA_PIXEL: 0

    ReadonlyeventPhase

    eventPhase: number

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

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

    ReadonlyoffsetX

    offsetX: number

    MDN Reference

    ReadonlyoffsetY

    offsetY: number

    MDN Reference

    ReadonlypageX

    pageX: number

    MDN Reference

    ReadonlypageY

    pageY: number

    MDN Reference

    ReadonlyrelatedTarget

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

    Deprecated

    MDN Reference

    Readonlytarget

    target: EventTarget

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

    MDN Reference

    ReadonlytimeStamp

    timeStamp: number

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

    MDN Reference

    Readonlytype

    type: string

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

    MDN Reference

    Readonlyview

    view: Window

    MDN Reference

    Readonlywhich

    which: number

    Deprecated

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

    getModifierState

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

      Returns void

      Deprecated

      MDN Reference

    initUIEvent

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

    • Parameters

      • typeArg: string
      • OptionalbubblesArg: boolean
      • OptionalcancelableArg: boolean
      • OptionalviewArg: 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