WheelEvent - Web APIs 编辑

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

Important: This is the standard wheel event interface to use. Old versions of browsers implemented the non-standard and non-cross-browser-compatible MouseWheelEvent and MouseScrollEvent interfaces. Use this interface and avoid the non-standard ones.

Do not confuse the wheel event with the scroll event: The default action of a wheel event is implementation-defined. Thus, a wheel event doesn't necessarily dispatch a scroll event. Even when it does, that doesn't mean that the delta* values in the wheel event necessarily reflect the content's scrolling direction. Therefore, do not rely on delta* properties to get the content's scrolling direction. Instead, detect value changes to scrollLeft and scrollTop of the target in the scroll event.

  <div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/wiki/en-US/docs/Web/API/Event" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text  x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Event</text></a><polyline points="76,25  86,20  86,30  76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/wiki/en-US/docs/Web/API/UIEvent" target="_top"><rect x="116" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text  x="153.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">UIEvent</text></a><polyline points="191,25  201,20  201,30  191,25" stroke="#D4DDE4" fill="none"/><line x1="201" y1="25" x2="231" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/wiki/en-US/docs/Web/API/MouseEvent" target="_top"><rect x="231" y="1" width="100" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text  x="281" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">MouseEvent</text></a><polyline points="331,25  341,20  341,30  331,25" stroke="#D4DDE4" fill="none"/><line x1="341" y1="25" x2="371" y2="25" stroke="#D4DDE4"/><a xlink:href="/wiki/en-US/docs/Web/API/WheelEvent" target="_top"><rect x="371" y="1" width="100" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text  x="421" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">WheelEvent</text></a></svg></div>

  a:hover text { fill: #0095DD; pointer-events: all;}

Constructor

WheelEvent()

Creates a WheelEvent object.

Properties

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

WheelEvent.deltaXRead only

Returns a double representing the horizontal scroll amount.

WheelEvent.deltaYRead only

Returns a double representing the vertical scroll amount.

WheelEvent.deltaZRead only

Returns a double representing the scroll amount for the z-axis.

WheelEvent.deltaModeRead only

Returns an unsigned long representing the unit of the delta* values' scroll amount. Permitted values are:

Constant	Value	Description
WheelEvent.DOM_DELTA_PIXEL	0x00	The delta* values are specified in pixels.
WheelEvent.DOM_DELTA_LINE	0x01	The delta* values are specified in lines.
WheelEvent.DOM_DELTA_PAGE	0x02	The delta* values are specified in pages.

Methods

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

Specifications

Browser compatibility

BCD tables only load in the browser

See also

• wheel event
• Interfaces replaced by this one:
  • Gecko's legacy mouse wheel event object: MouseScrollEvent
  • Non-gecko browsers' legacy mouse wheel event object: MouseWheelEvent