The MouseEvent()
constructor creates a new MouseEvent
.
Syntax
event = new MouseEvent(typeArg, mouseEventInit);
Values
- typeArg
- Is a
DOMString
representing the name of the event. - mouseEventInit Optional
- Is a
MouseEventInit
dictionary, having the following fields:"screenX"
, optional and defaulting to0
, of typelong
, that is the horizontal position of the mouse event on the user's screen; setting this value doesn't move the mouse pointer."screenY"
, optional and defaulting to0
, of typelong
, that is the vertical position of the mouse event on the user's screen; setting this value doesn't move the mouse pointer."clientX"
, optional and defaulting to0
, of typelong
, that is the horizontal position of the mouse event on the client window of user's screen; setting this value doesn't move the mouse pointer."clientY"
, optional and defaulting to0
, of typelong
, that is the vertical position of the mouse event on the client window of the user's screen; setting this value doesn't move the mouse pointer."ctrlKey"
, optional and defaulting tofalse
, of typeBoolean
, that indicates if the ctrl key was simultaneously pressed."shiftKey"
, optional and defaulting tofalse
, of typeBoolean
, that indicates if the shift key was simultaneously pressed."altKey"
, optional and defaulting tofalse
, of typeBoolean
, that indicates if the alt key was simultaneously pressed."metaKey"
, optional and defaulting tofalse
, of typeBoolean
, that indicates if the meta key was simultaneously pressed."button"
, optional and defaulting to0
, of typeshort
, that describes which button is pressed during events related to the press or release of a button:Value Meaning 0
Main button pressed (usually the left button) or un-initialized 1
Auxiliary button pressed (usually the middle button) 2
Secondary button pressed (usually the right button) "buttons"
, optional and defaulting to0
, of typeunsigned short
, that describes which buttons are pressed when the event is launched:Bit-field value Meaning 0
No button pressed 1
Main button pressed (usually the left button) 2
Secondary button pressed (usually the right button) 4
Auxiliary button pressed (usually the middle button) "relatedTarget"
, optional and defaulting tonull
, of typeEventTarget
, that is the element just left (in case of amouseenter
ormouseover
) or is entering (in case of amouseout
ormouseleave
)."region"
, optional and defaulting tonull
, of typeDOMString
, is the id of the hit region affected by the event. The absence of any hit region is affected, is represented by thenull
value.
The
MouseEventInit
dictionary also accepts fields fromUIEventInit
and fromEventInit
dictionaries.
Specifications
Specification | Status | Comment |
---|---|---|
WHATWG HTML Living Standard The definition of 'region value' in that specification. |
Living Standard | From Document Object Model (DOM) Level 3 Events Specification, added the "region" value in the dictionary. |
Document Object Model (DOM) Level 3 Events Specification The definition of 'MouseEvent()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | (Yes) | 11 (11) | 9 | (Yes) | ? |
"region" |
? | 32 (32) | ? | ? | ? |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | ? | ? | 11.0 (11) | 11 | ? | ? |
"region" |
? | ? | 32.0 (32) | ? | ? | ? |
See also
MouseEvent
, the interface of the objects it constructs.