WheelEvent: WheelEvent() constructor

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.

The WheelEvent() constructor returns a new WheelEvent object.

Note: If you construct a synthetic event using this constructor, that event will not be trusted, for security reasons. Only browser-generated WheelEvent objects are trusted and only trusted events trigger default actions.

Syntax

js
new WheelEvent(type)
new WheelEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers always set it to wheel.

options Optional

An object that, in addition of the properties defined in MouseEvent(), can have the following properties:

deltaX Optional

A floating number representing the horizontal scroll amount in the deltaMode unit. It defaults to 0.0.

deltaY Optional

A floating number representing the vertical scroll amount in the deltaMode unit. It defaults to 0.0.

deltaZ Optional

A floating number representing the scroll amount for the z-axis scroll amount in the deltaMode unit. It defaults to 0.0.

deltaMode Optional

An integer representing the unit of the delta values scroll amount. It defaults to 0x00. 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.

Return value

A new WheelEvent object.

Specifications

Specification
Pointer Events
# dom-wheelevent-constructor

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
WheelEvent() constructor
Chrome – Full support
Chrome 26 (Release date: 2013-03-26)
footnote Full support
Edge – Full support
Edge 12 (Release date: 2015-07-29)
footnote Full support
Firefox – Full support
Firefox 17 (Release date: 2012-11-20)
footnote Full support
Opera – Full support
Opera 15 (Release date: 2013-07-02)
footnote Full support
Safari – Full support
Safari 7 (Release date: 2013-10-22)
footnote Full support
Chrome Android – Full support
Chrome Android 26 (Release date: 2013-04-03)
footnote Full support
Firefox for Android – Full support
Firefox for Android 17 (Release date: 2012-11-20)
footnote Full support
Opera Android – Full support
Opera Android 14 (Release date: 2013-05-21)
footnote Full support
Safari on iOS – Full support
Safari on iOS 7 (Release date: 2013-09-18)
footnote Full support
Samsung Internet – Full support
Samsung Internet 1 (Release date: 2013-04-27)
footnote Full support
WebView Android – Full support
WebView Android 4.4 (Release date: 2013-12-09)
footnote Full support
WebView on iOS – Full support
WebView on iOS 7 (Release date: 2013-09-18)
footnote Full support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also