Back to Content

MouseScrollEvent

files/en-us/web/api/mousescrollevent/index.md

latest1.7 KB
Original Source

{{APIRef("UI Events")}}{{ Non-standard_Header }}{{Deprecated_Header}}

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

[!WARNING] Do not use this interface for wheel events.

Like MouseWheelEvent, this interface is non-standard and deprecated. It was used in Gecko-based browsers only. Instead use the standard {{domxref("WheelEvent")}}.

Method overview

webidl
void initMouseScrollEvent(
  in DOMString typeArg,
  in boolean canBubbleArg,
  in boolean cancelableArg,
  in nsIDOMAbstractView viewArg,
  in long detailArg,
  in long screenXArg,
  in long screenYArg,
  in long clientXArg,
  in long clientYArg,
  in boolean ctrlKeyArg,
  in boolean altKeyArg,
  in boolean shiftKeyArg,
  in boolean metaKeyArg,
  in unsigned short buttonArg,
  in nsIDOMEventTarget relatedTargetArg,
  in long axis);

Attributes

AttributeTypeDescription
axis {{ReadOnlyInline}}longIndicates scroll direction.

Constants

Delta modes

ConstantValueDescription
HORIZONTAL_AXIS0x01The event is caused by horizontal wheel operation.
VERTICAL_AXIS0x02The event is caused by vertical wheel operation.

Instance methods

  • initMouseScrollEvent()
    • : See nsIDOMMouseScrollEvent::initMouseScrollEvent().

Browser compatibility

{{Compat}}

See also

  • DOMMouseScroll
  • MozMousePixelScroll
  • Standardized mouse wheel event object: {{ domxref("WheelEvent") }}