1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
---
title: MouseEvent
slug: Web/API/MouseEvent
tags:
- API
translation_of: Web/API/MouseEvent
---
<p id="Summary">{{APIRef("DOM Events")}}</p>
<p>The <code><strong>MouseEvent</strong></code> interface represents events that occur due to the user interacting with a pointing device (such as a mouse). Common events using this interface include {{event("click")}}, {{event("dblclick")}}, {{event("mouseup")}}, {{event("mousedown")}}.</p>
<p><code>MouseEvent</code> derives from {{domxref("UIEvent")}}, which in turn derives from {{domxref("Event")}}. Though the {{domxref("MouseEvent.initMouseEvent()")}} method is kept for backward compatibility, creating of a <code>MouseEvent</code> object should be done using the {{domxref("MouseEvent.MouseEvent", "MouseEvent()")}} constructor.</p>
<p>Several more specific events derivate from <code>MouseEvent</code>: {{domxref("WheelEvent")}} and {{domxref("DragEvent")}}.</p>
<h2 id="Constructor">Constructor</h2>
<dl>
<dt>{{domxref("MouseEvent.MouseEvent", "MouseEvent()")}}</dt>
<dd>Creates a <code>MouseEvent</code> object.</dd>
</dl>
<h2 id="Properties">Properties</h2>
<p><em>This interface also inherits properties of its parents, {{domxref("UIEvent")}} and {{domxref("Event")}}.</em></p>
<dl>
<dt>{{domxref("MouseEvent.altKey")}} {{readonlyinline}}</dt>
<dd>Returns <code>true</code> if the <kbd>alt</kbd> key was down when the mouse event was fired.</dd>
<dt>{{domxref("MouseEvent.button")}} {{readonlyinline}}</dt>
<dd>The button number that was pressed when the mouse event was fired. </dd>
<dt>{{domxref("MouseEvent.buttons")}} {{readonlyinline}} {{gecko_minversion_inline("15.0")}}</dt>
<dd>
<p>The buttons being pressed when the mouse event was fired</p>
</dd>
<dt>{{domxref("MouseEvent.clientX")}} {{readonlyinline}}</dt>
<dd>The X coordinate of the mouse pointer in local (DOM content) coordinates.</dd>
<dt>{{domxref("MouseEvent.clientY")}} {{readonlyinline}}</dt>
<dd>The Y coordinate of the mouse pointer in local (DOM content) coordinates.</dd>
<dt>{{domxref("MouseEvent.ctrlKey")}} {{readonlyinline}}</dt>
<dd>Returns <code>true</code> if the <kbd>control</kbd> key was down when the mouse event was fired.</dd>
<dt>{{domxref("MouseEvent.metaKey")}} {{readonlyinline}}</dt>
<dd>Returns <code>true</code> if the <kbd>meta</kbd> key was down when the mouse event was fired.</dd>
<dt>{{domxref("MouseEvent.movementX")}} {{readonlyinline}}</dt>
<dd>The X coordinate of the mouse pointer relative to the position of the last {{event("mousemove")}} event.</dd>
<dt>{{domxref("MouseEvent.movementY")}} {{readonlyinline}}</dt>
<dd>The Y coordinate of the mouse pointer relative to the position of the last {{event("mousemove")}} event.</dd>
<dt>{{domxref("MouseEvent.region")}} {{readonlyinline}}</dt>
<dd>Returns the id of the hit region affected by the event. If no hit region is affected, <code>null</code> is returned.</dd>
<dt>{{domxref("MouseEvent.relatedTarget")}} {{readonlyinline}}</dt>
<dd>
<p>The secondary target for the event, if there is one.</p>
</dd>
<dt>{{domxref("MouseEvent.screenX")}} {{readonlyinline}}</dt>
<dd>The X coordinate of the mouse pointer in global (screen) coordinates.</dd>
<dt>{{domxref("MouseEvent.screenY")}} {{readonlyinline}}</dt>
<dd>The Y coordinate of the mouse pointer in global (screen) coordinates.</dd>
<dt>{{domxref("MouseEvent.shiftKey")}} {{readonlyinline}}</dt>
<dd>Returns <code>true</code> if the <kbd>shift</kbd> key was down when the mouse event was fired.</dd>
<dt>{{domxref("MouseEvent.which")}} {{non-standard_inline}} {{readonlyinline}}</dt>
<dd>The button being pressed when the mouse event was fired.</dd>
<dt>{{domxref("MouseEvent.mozPressure")}} {{non-standard_inline()}} {{readonlyinline}}</dt>
<dd>The amount of pressure applied to a touch or tablet device when generating the event; this value ranges between <code>0.0</code> (minimum pressure) and <code>1.0</code> (maximum pressure).</dd>
<dt>{{domxref("MouseEvent.mozInputSource")}} {{non-standard_inline()}} {{readonlyinline}}</dt>
<dd>
<p>The type of device that generated the event (one of the <code>MOZ_SOURCE_*</code> constants listed below). 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). The possible values are:</p>
<table class="standard-table">
<tbody>
<tr>
<th>Constant name</th>
<th>Value</th>
<th>Desription</th>
</tr>
<tr>
<td><code>MouseEvent.MOZ_SOURCE_UNKNOWN</code></td>
<td>0</td>
<td>The input device is unknown.</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_MOUSE</code></td>
<td>1</td>
<td>The event was generated by a mouse (or mouse-like device).</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_PEN</code></td>
<td>2</td>
<td>The event was generated by a pen on a tablet.</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_ERASER</code></td>
<td>3</td>
<td>The event was generated by an eraser on a tablet.</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_CURSOR</code></td>
<td>4</td>
<td>The event was generated by a cursor.</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_TOUCH</code></td>
<td>5</td>
<td>The event was generated on a touch interface.</td>
</tr>
<tr>
<td><code><code>MouseEvent.</code>MOZ_SOURCE_KEYBOARD</code></td>
<td>6</td>
<td>The event was generated by a keyboard.</td>
</tr>
</tbody>
</table>
</dd>
</dl>
<h2 id="Methods">Methods</h2>
<p><em>This interface also inherits methods of its parents, {{domxref("UIEvent")}} and {{domxref("Event")}}.</em></p>
<dl>
<dt>{{domxref("MouseEvent.getModifierState()")}}</dt>
<dd>Returns the current state of the specified modifier key. See the {{domxref("KeyboardEvent.getModifierState")}}() for details.</dd>
<dt>{{domxref("MouseEvent.initMouseEvent()")}} {{deprecated_inline}}</dt>
<dd>Initializes the value of a <code>MouseEvent</code> created. If the event has already being dispatched, this method does nothing.</dd>
</dl>
<h2 id="Example">Example</h2>
<p>This example demonstrates simulating a click (that is programmatically generating a click event) on a checkbox using DOM methods. </p>
<pre class="brush: js">function simulateClick() {
var evt = new <a href="/en-US/docs/Web/API/MouseEvent">MouseEvent</a>("click", {
bubbles: true,
cancelable: true,
view: window,
});
var cb = document.getElementById("checkbox"); //element to click on
var canceled = !cb.<a href="/en-US/docs/Web/API/EventTarget.dispatchEvent" rel="internal" title="en/DOM/element.dispatchEvent">dispatchEvent</a>(evt);
if(canceled) {
// A handler called preventDefault
alert("canceled");
} else {
// None of the handlers called preventDefault
alert("not canceled");
}
}
document.getElementById("button").addEventListener('click', simulateClick);</pre>
<pre class="brush: html"><p><label><input type="checkbox" id="checkbox"> Checked</label>
<p><button id="button">Click me</button></pre>
<p>Click on the button to see how the sample works:</p>
<p>{{ EmbedLiveSample('Example', '', '', '') }}</p>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName("HTML WHATWG", "#dom-mouseevent-region", "MouseEvent.region")}}</td>
<td>{{Spec2('HTML WHATWG')}}</td>
<td>From {{SpecName('DOM3 Events')}}, added the <code>region</code> property.</td>
</tr>
<tr>
<td>{{SpecName('Pointer Lock','#extensions-to-the-mouseevent-interface','MouseEvent')}}</td>
<td>{{Spec2('Pointer Lock')}}</td>
<td>From {{SpecName('DOM3 Events')}}, added <code>movementX</code> and <code>movementY</code> properties.</td>
</tr>
<tr>
<td>{{SpecName('DOM3 Events','#events-mouseevents','MouseEvent')}}</td>
<td>{{Spec2('DOM3 Events')}}</td>
<td>From {{SpecName('DOM2 Events')}}, added the <code>MouseEvent()</code> constructor, the <code>getModifierState()</code> method and the <code>buttons</code> property.</td>
</tr>
<tr>
<td>{{SpecName('DOM2 Events','#Events-MouseEvent','MouseEvent')}}</td>
<td>{{Spec2('DOM2 Events')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">Browser compatibility</h2>
{{Compat("api.MouseEvent")}}
<h2 id="See_also">See also</h2>
<ul>
<li>Its direct parent, {{domxref("UIEvent")}}.</li>
</ul>
|
