HTML DOM Level 2 Reference: MouseEvent

Provides information for a Mouse-related event.

Constructors

Constructor IE Mozilla Netscape Opera Safari Netscapte
MouseEvent Constructor
Provides information for a Mouse-related event.

Constructor	IE	Mozilla	Netscape	Opera	Safari	Netscapte
MouseEvent Constructor Provides information for a Mouse-related event.

Properties

Property IE Mozilla Netscape Opera Safari Netscapte
altKey
If true, indicates that the user pressed the "Alt" key while the event occurred.
4.0+ 1.0+ 6.0+ no 1.0+ no

button
Specifies which mouse button was clicked or released during a mousedown, mouseup, or click event.
5.0+ 1.75+ 6.0+ 8.0+ 1.2+ no
IE: Left button = "1". Right button = "2". Middle button = "4".
Mozilla: Left button = "0". Right button = "1". Middle button = "2". On Mac, recognizies "shift+click" as a right-button click.
Safari: Only detects the Left button click.
Opera: Left button = "0". Right button = "1". Middle button = "2".
clientX
Horizontal (x) coordinate of the mouse pointer in the window.
4.0+ 1.0+ 6.0+ 7.0+ 1.0+ no

clientY
Vertical (y) coordinate of the mouse pointer in the window.
4.0+ 1.0+ 6.0+ 7.0+ 1.0+ no

ctrlKey
If true, indicates that the user pressed the "Ctrl" key while the event occurred.
4.0+ 1.0+ 6.0+ 7.0+ 1.0+ no

metaKey
If true, indicates that the user pressed the "Meta" key while the event occurred.
no 1.75+ no no 1.0+ no
Mozilla: Mac only.
relatedTarget
Node related to the target node for the event.
no 1.0+ no 7.0+ 1.0+ no

screenX
Horizontal (x) coordinate of the mouse pointer relative to the upper-left corner of the client screen.
5.0+ 1.75+ 6.0+ 8.0+ 1.2+ no

screenY
Vertical (y) coordinate of the mouse pointer relative to the upper-left corner of the client screen.
5.0+ 1.75+ 6.0+ 8.0+ 1.2+ no

shiftKey
If true, indicates that the user pressed the "Shift" key while the event occurred.
5.0+ 1.75+ 6.0+ 8.0+ 1.2+ no

Property	IE	Mozilla	Netscape	Opera	Safari	Netscapte
altKey If true, indicates that the user pressed the "Alt" key while the event occurred.	4.0+	1.0+	6.0+	no	1.0+	no

button Specifies which mouse button was clicked or released during a mousedown, mouseup, or click event.	5.0+	1.75+	6.0+	8.0+	1.2+	no
IE: Left button = "1". Right button = "2". Middle button = "4". Mozilla: Left button = "0". Right button = "1". Middle button = "2". On Mac, recognizies "shift+click" as a right-button click. Safari: Only detects the Left button click. Opera: Left button = "0". Right button = "1". Middle button = "2".
clientX Horizontal (x) coordinate of the mouse pointer in the window.	4.0+	1.0+	6.0+	7.0+	1.0+	no

clientY Vertical (y) coordinate of the mouse pointer in the window.	4.0+	1.0+	6.0+	7.0+	1.0+	no

ctrlKey If true, indicates that the user pressed the "Ctrl" key while the event occurred.	4.0+	1.0+	6.0+	7.0+	1.0+	no

metaKey If true, indicates that the user pressed the "Meta" key while the event occurred.	no	1.75+	no	no	1.0+	no
Mozilla: Mac only.
relatedTarget Node related to the target node for the event.	no	1.0+	no	7.0+	1.0+	no

screenX Horizontal (x) coordinate of the mouse pointer relative to the upper-left corner of the client screen.	5.0+	1.75+	6.0+	8.0+	1.2+	no

screenY Vertical (y) coordinate of the mouse pointer relative to the upper-left corner of the client screen.	5.0+	1.75+	6.0+	8.0+	1.2+	no

shiftKey If true, indicates that the user pressed the "Shift" key while the event occurred.	5.0+	1.75+	6.0+	8.0+	1.2+	no

Methods

Method IE Mozilla Netscape Opera Safari Netscapte
initMouseEvent
Sets the initial property values for a new MouseEvent object.
no 1.0+ 6.0+ 7.0+ 1.0+ no

Method	IE	Mozilla	Netscape	Opera	Safari	Netscapte
initMouseEvent Sets the initial property values for a new MouseEvent object.	no	1.0+	6.0+	7.0+	1.0+	no

References

Event | UIEvent

Availability

HTML DOM Level 2 | W3C

Constructor Detail

MouseEvent MouseEvent()

Provides information for a Mouse-related event.

Visibility: internal

Property Detail

Boolean altKey - read only

If true, indicates that the user pressed the "Alt" key while the event occurred.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/keys.html

Availability

HTML DOM Level 2 | W3C

Number button - read only

Specifies which mouse button was clicked or released during a mousedown, mouseup, or click event.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/button.html

Availability

HTML DOM Level 2 | W3C

Number clientX - read only

Horizontal (x) coordinate of the mouse pointer in the window.

Availability: HTML DOM Level 2 | W3C

Number clientY - read only

Vertical (y) coordinate of the mouse pointer in the window.

Availability: HTML DOM Level 2 | W3C

Boolean ctrlKey - read only

If true, indicates that the user pressed the "Ctrl" key while the event occurred.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/keys.html

Availability

HTML DOM Level 2 | W3C

Boolean metaKey - read only

If true, indicates that the user pressed the "Meta" key while the event occurred.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/keys.html

Availability

HTML DOM Level 2 | W3C

EventTarget relatedTarget - read only

Node related to the target node for the event.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/targets.html

Availability

HTML DOM Level 2 | W3C

Number screenX - read only

Horizontal (x) coordinate of the mouse pointer relative to the upper-left corner of the client screen.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/mouseposition.html

Availability

HTML DOM Level 2 | W3C

Number screenY - read only

Vertical (y) coordinate of the mouse pointer relative to the upper-left corner of the client screen.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/mouseposition.html

Availability

HTML DOM Level 2 | W3C

Boolean shiftKey - read only

If true, indicates that the user pressed the "Shift" key while the event occurred.

For examples, see the quirksmode test page:

http://www.quirksmode.org/js/events/keys.html

Availability

HTML DOM Level 2 | W3C

Method Detail

initMouseEvent() : void

Sets the initial property values for a new MouseEvent object.

Availability: HTML DOM Level 2 | W3C

MouseEvent : UIEvent

Constructors

Properties

Methods

References

Availability

Constructor Detail

MouseEvent MouseEvent()

Property Detail

Boolean altKey - read only

Number button - read only

Number clientX - read only

Number clientY - read only

Boolean ctrlKey - read only

Boolean metaKey - read only

EventTarget relatedTarget - read only

Number screenX - read only

Number screenY - read only

Boolean shiftKey - read only

Method Detail

initMouseEvent() : void