MouseScrollEvent

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

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 WheelEvent.

Method overview

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

Attribute Type Description
axis Read only long Indicates scroll direction.

Constants

Delta modes

Constant Value Description
HORIZONTAL_AXIS 0x01 The event is caused by horizontal wheel operation.
VERTICAL_AXIS 0x02 The event is caused by vertical wheel operation.

Methods

initMouseScrollEvent()

See nsIDOMMouseScrollEvent::initMouseScrollEvent().

Browser compatibility

BCD tables only load in the browser

See also

  • DOMMouseScroll
  • MozMousePixelScroll
  • Non-gecko browsers' legacy mouse wheel event object: MouseWheelEvent
  • Standardized mouse wheel event object: WheelEvent