WheelEvent

The WheelEvent interface represents events that occur due to the user moving a mouse wheel or similar input device.

This is the standard wheel event interface to use.

Old versions of browsers implemented the two non-standard and non-cross-browser-compatible MouseWheelEvent and MouseScrollEvent interfaces. Use this interface and avoid the latter two.

Constructor

WheelEvent()
Creates a WheelEvent object.

Properties

This interface inherits properties from its parents, MouseEvent, UIEvent and Event.

WheelEvent.deltaX Read only
Returns a double representing the horizontal scroll amount.
WheelEvent.deltaY Read only
Returns a double representing the vertical scroll amount.
WheelEvent.deltaZ Read only
Returns a double representing the scroll amount for the z-axis.
WheelEvent.deltaMode Read only
Returns an unsigned long representing the unit of the delta values scroll amount. Permitted values are:
Constant Value Description
DOM_DELTA_PIXEL 0x00 The delta values are specified in pixels.
DOM_DELTA_LINE 0x01 The delta values are specified in lines.
DOM_DELTA_PAGE 0x02 The delta values are specified in pages.

Methods

This interface doesn't define any methods, but inherits methods from its parents, MouseEvent, UIEvent and Event.

Specifications

Specification Status Comment
Document Object Model (DOM) Level 3 Events Specification
The definition of 'WheelEvent' in that specification.
Working Draft Initial definition.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 31 (Yes) 17.0 (17.0) 9.0 18 7.0
window.WheelEvent (Yes) (Yes) 17.0 (17.0) 9.0 (Yes) (Yes) [1]
Pinch-to-zoom maps to WheelEvent + Ctrl key[2] (Yes) ? 55.0 (55.0) ? ? ?
Feature Android Android Webview Edge Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support No support (Yes) (Yes) 17.0 (17.0) ? (Yes) No support (Yes)
window.WheelEvent No support (Yes) ? 17.0 (17.0) ? (Yes) ? (Yes)
Pinch-to-zoom maps to WheelEvent + Ctrl key[2] ? ? ? 55.0 (55.0) ? ? ? (Yes)

[1] Safari doesn't support WheelEvent actually; nevertheless they return object for window.WheelEvent.

[2] This mapping was implemented to allow developers to implement simple zooming functionality using the pinch-to-zoom gesture on mobile screens/trackpads (mousewheel + Ctrl commonly zooms).

See also

Document Tags and Contributors

 Last updated by: chrisdavidmills,