MouseEvent
The DOM 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. The list of all events using this interface is provided in the Events reference.
MouseEvent derives from UIEvent, which in turn derives from Event.
Value members
Concrete methods
The button property indicates which button was pressed on the mouse to trigger the event.
The button property indicates which button was pressed on the mouse to trigger the event.
The buttons property indicates which buttons were pressed on the mouse to trigger the event.
The buttons property indicates which buttons were pressed on the mouse to trigger the event.
The clientX property provides the X coordinate of the mouse pointer in local (DOM content) coordinates.
The clientX property provides the X coordinate of the mouse pointer in local (DOM content) coordinates.
The clientY property provides the Y coordinate of the mouse pointer in local (DOM content) coordinates.
The clientY property provides the Y coordinate of the mouse pointer in local (DOM content) coordinates.
Returns the current state of the specified modifier key. See the KeyboardEvent.getModifierState() documentation for details.
Returns the current state of the specified modifier key. See the KeyboardEvent.getModifierState() documentation for details.
Provides the difference in the X coordinate of the mouse pointer between the given event and the previous mousemove event
Provides the difference in the X coordinate of the mouse pointer between the given event and the previous mousemove event
Provides the difference in the Y coordinate of the mouse pointer between the given event and the previous mousemove event
Provides the difference in the Y coordinate of the mouse pointer between the given event and the previous mousemove event
The pageX property is an integer value in pixels for the X coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any horizontal scrolling of the page.
The pageX property is an integer value in pixels for the X coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any horizontal scrolling of the page.
The pageY property is an integer value in pixels for the Y coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any vertical scrolling of the page.
The pageY property is an integer value in pixels for the Y coordinate of the mouse pointer, relative to the whole document, when the mouse event fired. This property takes into account any vertical scrolling of the page.
The screenX property provides the X coordinate of the mouse pointer in global (screen) coordinates.
The screenX property provides the X coordinate of the mouse pointer in global (screen) coordinates.
Inherited methods
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
- Inherited from:
- ModifierKeyEvent
A boolean indicating whether the event bubbles up through the DOM or not.
A boolean indicating whether the event bubbles up through the DOM or not.
- Inherited from:
- Event
A boolean indicating whether the bubbling of the event has been canceled or not.
A boolean indicating whether the bubbling of the event has been canceled or not.
- Inherited from:
- Event
A boolean indicating whether the event is cancelable.
A boolean indicating whether the event is cancelable.
- Inherited from:
- Event
Indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
Indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
- Inherited from:
- Event
A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.
A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.
- Inherited from:
- ModifierKeyEvent
Identifies the current target for the event, as the event traverses the DOM. It always refers to the element the event handler has been attached to as opposed to event.target which identifies the element on which the event occurred.
Identifies the current target for the event, as the event traverses the DOM. It always refers to the element the event handler has been attached to as opposed to event.target which identifies the element on which the event occurred.
- Inherited from:
- Event
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
- Inherited from:
- Event
Detail about the event, depending on the type of event. Read only.
Detail about the event, depending on the type of event. Read only.
- Inherited from:
- UIEvent
Indicates which phase of the event flow is currently being evaluated.
Indicates which phase of the event flow is currently being evaluated.
- Inherited from:
- Event
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)
- Inherited from:
- Event
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
- Inherited from:
- ModifierKeyEvent
Cancels the event if it is cancelable, without stopping further propagation of the event.
Cancels the event if it is cancelable, without stopping further propagation of the event.
- Inherited from:
- Event
A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.
A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.
- Inherited from:
- ModifierKeyEvent
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
- Inherited from:
- Event
Stops the propagation of events further along in the DOM.
Stops the propagation of events further along in the DOM.
- Inherited from:
- Event
This property of event objects is the object the event was dispatched on. It is different than event.currentTarget when the event handler is called in bubbling or capturing phase of the event.
This property of event objects is the object the event was dispatched on. It is different than event.currentTarget when the event handler is called in bubbling or capturing phase of the event.
- Inherited from:
- Event
Returns the time (in milliseconds since the epoch) at which the event was created.
Returns the time (in milliseconds since the epoch) at which the event was created.
- Inherited from:
- Event