WheelEvent
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
* Some parts of this feature may have varying levels of support.
TheWheelEvent interface represents events that occur due to the user moving a mouse wheel or similar input device.
Note:This is the standard wheel event interface to use. Old versions of browsers implemented the non-standard and non-cross-browser-compatibleMouseWheelEvent andMouseScrollEvent interfaces. Use this interface and avoid the non-standard ones.
Don't confuse thewheel event with thescroll event:
- A
wheelevent doesn't necessarily dispatch ascrollevent. For example, the element may be unscrollable at all. Zooming actions using the wheel or trackpad also firewheelevents. - A
scrollevent isn't necessarily triggered by awheelevent. Elements can also be scrolled by using the keyboard, dragging a scrollbar, or using JavaScript. - Even when the
wheelevent does trigger scrolling, thedelta*values in thewheelevent don't necessarily reflect the content's scrolling direction.
In this article
Constructor
WheelEvent()Creates a
WheelEventobject.
Instance properties
This interface inherits properties from its ancestors,MouseEvent,UIEvent, andEvent.
WheelEvent.deltaXRead onlyReturns a
doublerepresenting the horizontal scroll amount.WheelEvent.deltaYRead onlyReturns a
doublerepresenting the vertical scroll amount.WheelEvent.deltaZRead onlyReturns a
doublerepresenting the scroll amount for the z-axis.WheelEvent.deltaModeRead onlyReturns an
unsigned longrepresenting the unit of thedelta*values' scroll amount.WheelEvent.wheelDeltaRead onlyDeprecatedNon-standardReturns an integer (32-bit) representing the distance in pixels.
WheelEvent.wheelDeltaXRead onlyDeprecatedNon-standardReturns an integer representing the horizontal scroll amount.
WheelEvent.wheelDeltaYRead onlyDeprecatedNon-standardReturns an integer representing the vertical scroll amount.
Note:Element: mousewheel event has additional documentation about the deprecated propertieswheelDelta,wheelDeltaX,wheelDeltaY.
Instance methods
This interface doesn't define any specific methods, but inherits methods from its ancestors,MouseEvent,UIEvent, andEvent.
Specifications
| Specification |
|---|
| UI Events> # interface-wheelevent> |
Browser compatibility
See also
wheelevent- Interfaces replaced by this one:
- Gecko's legacy mouse wheel event object:
MouseScrollEvent
- Gecko's legacy mouse wheel event object: