Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WheelEvent

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

Hierarchy

Index

Properties

Readonly AT_TARGET

AT_TARGET: number

Readonly BUBBLING_PHASE

BUBBLING_PHASE: number

Readonly CAPTURING_PHASE

CAPTURING_PHASE: number

Readonly DOM_DELTA_LINE

DOM_DELTA_LINE: number

Readonly DOM_DELTA_PAGE

DOM_DELTA_PAGE: number

Readonly DOM_DELTA_PIXEL

DOM_DELTA_PIXEL: number

MouseEvent

MouseEvent: { constructor: any; prototype: MouseEvent }

Type declaration

Readonly NONE

NONE: number

Readonly altKey

altKey: boolean

Readonly bubbles

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.

Readonly button

button: number

Readonly buttons

buttons: number

cancelBubble

cancelBubble: boolean

Readonly cancelable

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.

Readonly clientX

clientX: number

Readonly clientY

clientY: number

Readonly composed

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.

Readonly ctrlKey

ctrlKey: boolean

Readonly currentTarget

currentTarget: EventTarget | null

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

Readonly defaultPrevented

defaultPrevented: boolean

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

Readonly deltaMode

deltaMode: number

Readonly deltaX

deltaX: number

Readonly deltaY

deltaY: number

Readonly deltaZ

deltaZ: number

Readonly detail

detail: number

Readonly eventPhase

eventPhase: number

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

Readonly isTrusted

isTrusted: boolean

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

Readonly metaKey

metaKey: boolean

Readonly movementX

movementX: number

Readonly movementY

movementY: number

Readonly offsetX

offsetX: number

Readonly offsetY

offsetY: number

Readonly pageX

pageX: number

Readonly pageY

pageY: number

Readonly relatedTarget

relatedTarget: EventTarget | null

returnValue

returnValue: boolean

Readonly screenX

screenX: number

Readonly screenY

screenY: number

Readonly shiftKey

shiftKey: boolean

Readonly srcElement

srcElement: EventTarget | null
deprecated

Readonly target

target: EventTarget | null

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

Readonly timeStamp

timeStamp: number

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

Readonly type

type: string

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

Readonly view

view: Window | null

Readonly which

which: number
deprecated

Readonly x

x: number

Readonly y

y: number

Methods

composedPath

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

    Returns EventTarget[]

getModifierState

  • getModifierState(keyArg: string): boolean
  • Parameters

    • keyArg: string

    Returns boolean

initEvent

  • initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void
  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

initMouseEvent

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

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.

    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.

    Returns void

stopPropagation

  • stopPropagation(): void
  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    Returns void

Generated using TypeDoc