WheelEvent
Pointer Events
Pointer Events
The WheelEvent 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-compatible
MouseWheelEventand MouseScrollEvent interfaces. Use this interface and avoid the non-standard ones.
Don't confuse the wheel event with the scroll 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.
Constructor
- WheelEvent()
- : Creates a
WheelEventobject.
Instance properties
This interface inherits properties from its ancestors, MouseEvent, UIEvent, and Event.
- WheelEvent.deltaX
- : Returns a
doublerepresenting the horizontal scroll amount. - WheelEvent.deltaY
- : Returns a
doublerepresenting the vertical scroll amount. - WheelEvent.deltaZ
- : Returns a
doublerepresenting the scroll amount for the z-axis. - WheelEvent.deltaMode
- : Returns an
unsigned longrepresenting the unit of thedelta*values' scroll amount. - WheelEvent.wheelDelta
- : Returns an integer (32-bit) representing the distance in pixels.
- WheelEvent.wheelDeltaX
- : Returns an integer representing the horizontal scroll amount.
- WheelEvent.wheelDeltaY
- : Returns an integer representing the vertical scroll amount.
[!NOTE] Element: mousewheel event has additional documentation about the deprecated properties
wheelDelta,wheelDeltaX,wheelDeltaY.
Instance methods
This interface doesn't define any specific methods, but inherits methods from its ancestors, MouseEvent, UIEvent, and Event.
Specifications
Browser compatibility
See also
- wheel event
- Interfaces replaced by this one:
- Gecko's legacy mouse wheel event object: MouseScrollEvent