Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MouseEvent object

Provides event properties that are specific to mouse events.

Document Object Model (DOM) Level 3 Events Specification, Section 5.2.3

DOM Information

Inheritance Hierarchy

 Event
    MouseEvent
 UIEvent
    MouseEvent

Members

The MouseEvent object has these types of members:

Methods

The MouseEvent object has these methods.

MethodDescription
getModifierState

Queries the state of the specified modifier key.

initEvent

Initializes a new generic event that the createEvent method created.

initMouseEvent

Initializes a new mouse event that the createEvent method created.

initUIEvent

Initializes a new user interface event that the createEvent method created.

preventDefault

Cancels the default action of an event.

stopImmediatePropagation

Prevents any further propagation of an event.

stopPropagation

Prevents propagation of an event beyond the current target.

 

Properties

The MouseEvent object has these properties.

PropertyDescription

altKey

Gets a value that indicates whether the Alt key is pressed.

bubbles

Gets a value that indicates whether an event propagates up from the event target.

button

Indicates which pointer device button has changed.

buttons

Indicates which pointer device buttons are being pressed, expressed as a bitmask.

cancelable

Gets a value that indicates whether you can cancel an event's default action.

cancelBubble

Gets or sets a value that indicates whether an event should be stopped from propagating up from the current target.

clientX

Gets the x-coordinate of the mouse pointer, relative to the upper-left corner of the viewport (that is, the application's client area).

clientY

Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the viewport (that is, the application's client area).

ctrlKey

Gets a value that indicates whether the Ctrl key is pressed.

currentTarget

Gets the event target that is currently being processed.

defaultPrevented

Gets a value that indicates whether the default action should be canceled.

detail

Gets additional information about an event.

eventPhase

Gets the event phase that is being evaluated.

fromElement

Gets the object that the mouse pointer exited.

isTrusted

Gets a value that indicates whether a trusted event source created an event.

layerX

Gets the x-coordinate of the mouse pointer, relative to the last positioned ancestor element.

layerY

Gets the y-coordinate of the mouse pointer, relative to the last positioned ancestor element.

metaKey

Gets a value that indicates whether the Meta/Control key is pressed.

offsetX

Gets the x-coordinate of the mouse pointer, relative to the target node.

offsetY

Gets the y-coordinate of the mouse pointer, relative to the target node.

pageX

Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the page.

pageY

Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the page.

relatedTarget

Gets the secondary element that is involved in an event.

screenX

Gets the x-coordinate of the mouse pointer, relative to the upper-left corner of the screen.

screenY

Gets the y-coordinate of the mouse pointer, relative to the upper-left corner of the screen.

shiftKey

Gets a value that indicates whether the Shift key is pressed.

srcElement

Gets the element that the event was originally dispatched to. Compare to target.

target

Gets the element that is the target of the event.

timeStamp

Gets the time, in milliseconds, when an event occurred.

toElement

Gets the object that the mouse pointer entered.

type

Gets the name of an event.

view

Gets the window object that an event is generated from.

x

Gets the x-coordinate of the mouse pointer, relative to the last positioned ancestor element.

y

Gets the y-coordinate of the mouse pointer, relative to the last positioned ancestor element.

 

Standards information

See also

Reference
onmousedown
onmousemove
onmouseout
onmouseover
onmouseup

 

 

Show:
© 2014 Microsoft. All rights reserved.