Back to Content

WheelEvent: deltaMode property

files/en-us/web/api/wheelevent/deltamode/index.md

latest1.3 KB
Original Source

{{APIRef("Pointer Events")}}

The WheelEvent.deltaMode read-only property returns an unsigned long representing the unit of the delta values scroll amount. Permitted values are:

ConstantValueDescription
DOM_DELTA_PIXEL0x00The delta values are specified in pixels.
DOM_DELTA_LINE0x01The delta values are specified in lines.
DOM_DELTA_PAGE0x02The delta values are specified in pages.

You must check the deltaMode property to determine the unit of the deltaX, deltaY, and deltaZ values. Do not assume that those values are specified in pixels. Some browsers, for compatibility reasons, may return different units for the delta* values depending on whether deltaMode has been accessed, to accommodate for websites not explicitly checking the deltaMode property.

Value

An unsigned long.

Examples

js
const syntheticEvent = new WheelEvent("syntheticWheel", {
  deltaX: 4,
  deltaMode: 0,
});

console.log(syntheticEvent.deltaMode);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("Element/wheel_event","wheel")}}
  • {{domxref("WheelEvent")}}