{{APIRef("DOM Events")}}
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 {{ domxref("MouseWheelEvent") }} and {{domxref("MouseScrollEvent")}} interfaces. Use this interface and avoid the latter two.
{{InheritanceDiagram}}
Constructor
- {{domxref("WheelEvent.WheelEvent", "WheelEvent()")}}
- Creates a
WheelEvent
object.
Properties
This interface inherits properties from its parents, {{domxref("MouseEvent")}}, {{domxref("UIEvent")}} and {{domxref("Event")}}.
- {{domxref("WheelEvent.deltaX")}} {{readonlyinline}}
- Returns a
double
representing the horizontal scroll amount. - {{domxref("WheelEvent.deltaY")}} {{readonlyinline}}
- Returns a
double
representing the vertical scroll amount. - {{domxref("WheelEvent.deltaZ")}} {{readonlyinline}}
- Returns a
double
representing the scroll amount for the z-axis. - {{domxref("WheelEvent.deltaMode")}} {{readonlyinline}}
- 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. D
OM_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, {{domxref("MouseEvent")}}, {{domxref("UIEvent")}} and {{domxref("Event")}}.
Specifications
Specification | Status | Comment |
---|---|---|
{{SpecName('DOM3 Events','#interface-WheelEvent','WheelEvent')}} | {{Spec2('DOM3 Events')}} | Initial definition. |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 31 | {{ CompatGeckoDesktop("17.0") }} | {{ CompatIE("9.0") }} | 18 | {{CompatNo}} |
window.WheelEvent |
{{CompatVersionUnknown}} | {{ CompatGeckoDesktop("17.0") }} | {{ CompatIE("9.0") }} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} [1] |
Feature | Android | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{ CompatGeckoMobile("17.0") }} | {{CompatUnknown}} | {{CompatVersionUnknown}} | {{CompatNo}} |
window.WheelEvent |
{{CompatVersionUnknown}} | {{ CompatGeckoMobile("17.0") }} | {{CompatUnknown}} | {{CompatVersionUnknown}} | {{CompatUnknown}} |
[1] Safari don't support WheelEvent
actually; nevertheless they return object for window.WheelEvent
.
See also
- {{ event("wheel") }}
- Interfaces replaced by this one:
- Gecko's legacy mouse wheel event object: {{ domxref("MouseScrollEvent") }}
- Non-gecko browsers' legacy mouse wheel event object: {{ domxref("MouseWheelEvent") }}