@nextcloud/dialogs
    Preparing search index...

    Interface WheelEvent

    The WheelEvent interface represents 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 | null;
        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 | null;
        returnValue: boolean;
        screenX: number;
        screenY: number;
        shiftKey: boolean;
        srcElement: EventTarget | null;
        target: EventTarget | null;
        timeStamp: number;
        type: string;
        view: Window | null;
        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 | 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

    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

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

    deltaMode: number

    The WheelEvent.deltaMode read-only property returns an unsigned long representing the unit of the delta values scroll amount.

    MDN Reference

    deltaX: number

    The WheelEvent.deltaX read-only property is a double representing the horizontal scroll amount in the You must check the deltaMode property to determine the unit of the deltaX value.

    MDN Reference

    deltaY: number

    The WheelEvent.deltaY read-only property is a double representing the vertical scroll amount in the You must check the deltaMode property to determine the unit of the deltaY value.

    MDN Reference

    deltaZ: number

    The WheelEvent.deltaZ read-only property is a double representing the scroll amount along the z-axis, in the You must check the deltaMode property to determine the unit of the deltaZ value.

    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

    DOM_DELTA_LINE: 1

    ReadonlyDOM_DELTA_PAGE

    DOM_DELTA_PAGE: 2
    DOM_DELTA_PIXEL: 0
    eventPhase: number

    The eventPhase read-only property of the being evaluated.

    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

    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.

    MDN Reference

    target: EventTarget | null

    The read-only target property of the dispatched.

    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

    type: string

    The type read-only property of the Event interface returns a string containing the event's type.

    MDN Reference

    view: Window | null

    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

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