MouseEvent

The MouseEvent interface represents events that occur due to the user interacting with a pointing device (such as a mouse). Common events using this interface include click, dblclick, mouseup, mousedown.

MouseEvent derives from UIEvent, which in turn derives from Event. Though the initMouseEvent() method is kept for backward compatibility, creating of a MouseEvent object should be done using the MouseEvent() constructor.

Several more specific events are based on MouseEvent, including WheelEvent, DragEvent, and PointerEvent.

Constructor

• MouseEvent()
  • : Creates a MouseEvent object.

Static properties

• MouseEvent.WEBKIT_FORCE_AT_MOUSE_DOWN Read only
  • : Minimum force necessary for a normal click.
• MouseEvent.WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN Read only
  • : Minimum force necessary for a force click.

Instance properties

This interface also inherits properties of its parents, UIEvent and Event.

• altKey Read only
  • : Returns true if the alt key was down when the mouse event was fired.
• button Read only
  • : The button number that was pressed or released (if applicable) when the mouse event was fired.
• buttons Read only
  • : The buttons being pressed (if any) when the mouse event was fired.
• clientX Read only
  • : The X coordinate of the mouse pointer in viewport coordinates.
• clientY Read only
  • : The Y coordinate of the mouse pointer in viewport coordinates.
• ctrlKey Read only
  • : Returns true if the control key was down when the mouse event was fired.
• layerX Read only
  • : Returns the horizontal coordinate of the event relative to the current layer.
• layerY Read only
  • : Returns the vertical coordinate of the event relative to the current layer.
• metaKey Read only
  • : Returns true if the meta key was down when the mouse event was fired.
• movementX Read only
  • : The X coordinate of the mouse pointer relative to the position of the last move event of the same type (a mousemove, pointermove, or pointerrawupdate).
• movementY Read only
  • : The Y coordinate of the mouse pointer relative to the position of the last move event of the same type (a mousemove, pointermove, or pointerrawupdate).
• offsetX Read only
  • : The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
• offsetY Read only
  • : The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
• pageX Read only
  • : The X coordinate of the mouse pointer relative to the whole document.
• pageY Read only
  • : The Y coordinate of the mouse pointer relative to the whole document.
• relatedTarget Read only
  • : The secondary target for the event, if there is one.
• screenX Read only
  • : The X coordinate of the mouse pointer in screen coordinates.
• screenY Read only
  • : The Y coordinate of the mouse pointer in screen coordinates.
• shiftKey Read only
  • : Returns true if the shift key was down when the mouse event was fired.
• mozInputSource Read only
  • : The type of device that generated the event (one of the MOZ_SOURCE_* constants). This lets you, for example, determine whether a mouse event was generated by an actual mouse or by a touch event (which might affect the degree of accuracy with which you interpret the coordinates associated with the event).
• webkitForce Read only
  • : The amount of pressure applied when clicking.
• x Read only
  • : Alias for clientX.
• y Read only
  • : Alias for clientY.

Instance methods

This interface also inherits methods of its parents, UIEvent and Event.

• getModifierState()
  • : Returns the current state of the specified modifier key. See KeyboardEvent.getModifierState() for details.
• initMouseEvent() Deprecated
  • : Initializes the value of a MouseEvent created. If the event has already been dispatched, this method does nothing.

Example

This example demonstrates simulating a click (programmatically generating a click event) on a checkbox using DOM methods. Event state (canceled or not) is then determined with the return value of method EventTarget.dispatchEvent().

HTML

<p>
  <label><input type="checkbox" id="checkbox" /> Checked</label>
</p>
<p>
  <button id="button">Click me to send a MouseEvent to the checkbox</button>
</p>

JavaScript

function simulateClick() {
  // Get the element to send a click event
  const cb = document.getElementById("checkbox");

  // Create a synthetic click MouseEvent
  let evt = new MouseEvent("click", {
    bubbles: true,
    cancelable: true,
    view: window,
  });

  // Send the event to the checkbox element
  cb.dispatchEvent(evt);
}
document.getElementById("button").addEventListener("click", simulateClick);

Result

Specifications

Browser compatibility

See also

• Its direct parent, UIEvent
• PointerEvent: For advanced pointer events, including multi-touch