MouseEvent
Pointer Events
Pointer Events
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 MouseEvent.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
MouseEventobject.
Static properties
- MouseEvent.WEBKIT_FORCE_AT_MOUSE_DOWN
- : Minimum force necessary for a normal click.
- MouseEvent.WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN
- : Minimum force necessary for a force click.
Instance properties
This interface also inherits properties of its parents, UIEvent and Event.
- MouseEvent.altKey
- : Returns
trueif the alt key was down when the mouse event was fired. - MouseEvent.button
- : The button number that was pressed or released (if applicable) when the mouse event was fired.
- MouseEvent.buttons
- : The buttons being pressed (if any) when the mouse event was fired.
- MouseEvent.clientX
- : The X coordinate of the mouse pointer in viewport coordinates.
- MouseEvent.clientY
- : The Y coordinate of the mouse pointer in viewport coordinates.
- MouseEvent.ctrlKey
- : Returns
trueif the control key was down when the mouse event was fired. - MouseEvent.layerX
- : Returns the horizontal coordinate of the event relative to the current layer.
- MouseEvent.layerY
- : Returns the vertical coordinate of the event relative to the current layer.
- MouseEvent.metaKey
- : Returns
trueif the meta key was down when the mouse event was fired. - MouseEvent.movementX
- : 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).
- MouseEvent.movementY
- : 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).
- MouseEvent.offsetX
- : The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
- MouseEvent.offsetY
- : The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
- MouseEvent.pageX
- : The X coordinate of the mouse pointer relative to the whole document.
- MouseEvent.pageY
- : The Y coordinate of the mouse pointer relative to the whole document.
- MouseEvent.relatedTarget
- : The secondary target for the event, if there is one.
- MouseEvent.screenX
- : The X coordinate of the mouse pointer in screen coordinates.
- MouseEvent.screenY
- : The Y coordinate of the mouse pointer in screen coordinates.
- MouseEvent.shiftKey
- : Returns
trueif the shift key was down when the mouse event was fired. - MouseEvent.mozInputSource
- : 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). - MouseEvent.webkitForce
- : The amount of pressure applied when clicking.
- MouseEvent.x
- : Alias for MouseEvent.clientX.
- MouseEvent.y
- : Alias for MouseEvent.clientY.
Instance methods
This interface also inherits methods of its parents, UIEvent and Event.
- MouseEvent.getModifierState()
- : Returns the current state of the specified modifier key. See KeyboardEvent.getModifierState() for details.
- MouseEvent.initMouseEvent()
- : Initializes the value of a
MouseEventcreated. 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
Example
Specifications
Browser compatibility
See also
- Its direct parent, UIEvent
- PointerEvent: For advanced pointer events, including multi-touch