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
|
---
title: MouseEvent
slug: Web/API/MouseEvent
tags:
- API
- DOM
- Interface
- Reference
- Référence(2)
- Souris
- évènements
translation_of: Web/API/MouseEvent
---
{{APIRef("DOM Events")}}
L'interface **`MouseEvent`** représente les événements qui se produisent lors d'une interaction de l'utilisateur avec un appareil de pointage (tel qu'une souris). Les événements communs utilisant cette interface incluent {{event("click")}}, {{event("dblclick")}}, {{event("mouseup")}} et {{event("mousedown")}}.
`MouseEvent` dérive de {{domxref("UIEvent")}}, qui lui-même est issu d'{{domxref("Event")}}. Bien que la méthode {{domxref ("MouseEvent.initMouseEvent()")}} soit conservée à des fins de compatibilité descendante, la création d'un objet `MouseEvent` doit être effectuée à l'aide du constructeur {{domxref ("MouseEvent.MouseEvent","MouseEvent()")}}.
Plusieurs événements plus spécifiques sont basés sur `MouseEvent`, y compris {{domxref ("WheelEvent")}} et {{domxref ("DragEvent")}}.
## Constructeur
- {{domxref("MouseEvent.MouseEvent", "MouseEvent()")}}
- : crée un objet `MouseEvent`.
## Propriétés
_Cette interface hérite aussi des propriétés de ses parents_ _{{domxref("UIEvent")}} et {{domxref("Event")}}._
- {{domxref("MouseEvent.altKey")}} {{readonlyinline}}
- : renvoie `true` (_vrai_) si la touche
<kbd>alt</kbd>
est pressée lorsque l'événement est lancé.
- {{domxref("MouseEvent.button")}} {{readonlyinline}}
- : Le chiffre représentant le bouton qui est pressé lorsque l'événement est lancé.
- {{domxref("MouseEvent.buttons")}} {{readonlyinline}}{{gecko_minversion_inline("15.0")}}
- : Les boutons qui sont pressés alors que l'événement est lancé.
- {{domxref("MouseEvent.clientX")}} {{readonlyinline}}
- : La coordonnée en X du pointeur de la souris dans les coordonnées locales (contenu du DOM).
- {{domxref("MouseEvent.clientY")}} {{readonlyinline}}
- : La coordonnée en Y du pointeur de la souris dans les coordonnées locales (contenu du DOM).
- {{domxref("MouseEvent.ctrlKey")}} {{readonlyinline}}
- : renvoie `true` si la touche
<kbd>ctrl</kbd>
est pressée alors que l'événement est lancé.
- {{domxref("MouseEvent.metaKey")}} {{readonlyinline}}
- : renvoie `true` si la touche
<kbd>méta</kbd>
est pressée alors que l'événement est lancé.
- {{domxref("MouseEvent.movementX")}} {{readonlyinline}}
- : La coordonnée en X du pointeur de la souris relative à la position de la souris lors du dernier événement {{event("mousemove")}} lancé.
- {{domxref("MouseEvent.movementY")}} {{readonlyinline}}
- : La coordonnée en Y du pointeur de la souris relative à la position de la souris lors du dernier événement {{event("mousemove")}} lancé.
- {{domxref("MouseEvent.offsetX")}} {{readonlyinline}}{{experimental_inline}}
- : La coordonnée en X du pointeur de la souris relative à la postion du bord de remplissage du noeud cible.
- {{domxref("MouseEvent.offsetY")}} {{readonlyinline}}{{experimental_inline}}
- : La coordonnée en Y du pointeur de la souris relative à la postion du bord de remplissage du noeud cible.
- {{domxref("MouseEvent.pageX")}} {{readonlyinline}}{{experimental_inline}}
- : La coordonnée en X du pointeur de la souris relative au document entier.
- {{domxref("MouseEvent.pageY")}} {{readonlyinline}}{{experimental_inline}}
- : La coordonnée en Y du pointeur de la souris relative au document entier.
- {{domxref("MouseEvent.region")}} {{readonlyinline}}
- : renvoie l'identifiant de la région touchée par l'évènement. Si aucune région n'est affectée, `null` est retourné.
- {{domxref("MouseEvent.relatedTarget")}} {{readonlyinline}}
- : La seconde cible pour l'événement, s'il y en a une.
- {{domxref("MouseEvent.screenX")}} {{readonlyinline}}
- : La coordonnée en X du pointeur de la souris de façon globale (par rapport à l'écran).
- {{domxref("MouseEvent.screenY")}} {{readonlyinline}}
- : La coordonnée en Y du pointeur de la souris de façon globale (par rapport à l'écran).
- {{domxref("MouseEvent.shiftKey")}} {{readonlyinline}}
- : renvoie `true` si la touche
<kbd>Maj</kbd>
est pressée alors que l'événement est lancé.
- {{domxref("MouseEvent.which")}} {{readonlyinline}}
- : Le bouton qui est pressé alors que l'événement est lancé.
- MouseEvent.mozPressure {{non-standard_inline()}} {{readonlyinline}}
- : La quantité de pression appliquée à un appareil tactile ou tablette lors de la génération de l'événement ; l'amplitude de cette valeur se situe entre 0.0 (pression minimum) et 1.0 (pression maximum).
- MouseEvent.mozInputSource {{non-standard_inline()}} {{readonlyinline}}
- : Le type d'appareil qui a généré l'événement (une des constantes `MOZ_SOURCE_*` listées ci-dessous). Ceci permet, par exemple, de déterminer si un événement de pointeur est généré par une souris ou par un événement tactile (qui pourrait affecter le degré de précision avec lequel il est possible d'interpréter les coordonnées associées à l'événement).
- {{domxref("MouseEvent.webkitForce")}} {{non-standard_inline()}} {{readonlyinline}}
- : La quantité de pression appliquée en cliquant.
- {{domxref("MouseEvent.x")}} {{experimental_inline}}{{readonlyinline}}
- : Alias pour {{domxref("MouseEvent.clientX")}}.
- {{domxref("MouseEvent.y")}} {{experimental_inline}}{{readonlyinline}}
- : Alias pour {{domxref("MouseEvent.clientY")}}.
## Constantes
- {{domxref("MouseEvent.WEBKIT_FORCE_AT_MOUSE_DOWN")}} {{non-standard_inline}}{{readonlyinline}}
- : Force minimum nécessaire pour un click normal.
- {{domxref("MouseEvent.WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN")}} {{non-standard_inline}}{{readonlyinline}}
- : Force minimum nécessaire pour un click fort.
## Les méthodes
_Cette interface hérite aussi des méthodes de ses parents_ _{{domxref("UIEvent")}} et {{domxref("Event")}}._
- {{domxref("MouseEvent.getModifierState")}}(){{gecko_minversion_inline("15.0")}}
- : Retourne l'état actuel de la touche de modification spécifiée. Voir {{domxref("KeyboardEvent.getModifierState")}}() pour plus de détails.
- {{domxref("MouseEvent.initMouseEvent()")}} {{deprecated_inline}}
- : initialise la valeur de l'`MouseEvent` créé. Si l'évènement a déjà été diffusé, la méthode ne produit rien.
## Exemple
Cet exemple illustre la simulation d'un clic (générant par programmation un événement click) sur une case à cocher en utilisant les méthodes DOM.
```js
function simulateClick() {
var evt = new MouseEvent("click", {
bubbles: true,
cancelable: true,
view: window
});
var cb = document.getElementById("checkbox"); //élément pour cliquer
var canceled = !cb.dispatchEvent(evt);
if(canceled) {
// Un gestionnaire appelé preventDefault
alert("canceled");
} else {
// Aucun des gestionnaires n'est appelé preventDefault
alert("not canceled");
}
}
document.getElementById("button").addEventListener('click', simulateClick);
```
```html
<p><label><input type="checkbox" id="checkbox"> Checked</label>
<p><button id="button">Click me</button>
```
Cliquez sur le bouton pour voir comment l'exemple fonctionne :
{{ EmbedLiveSample('Example', '', '', '') }}
## Spécifications
| Spécification | Statut | Commentaire |
| ---------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| {{SpecName('CSSOM View','#extensions-to-the-mouseevent-interface', 'MouseEvent')}} | {{Spec2('CSSOM View')}} | Redéfinit `MouseEvent` de long à double. C'est-à-dire qu'un `PointerEvent` dont le `pointerType` est "souris" est un double. |
| {{SpecName("HTML WHATWG", "#dom-mouseevent-region", "MouseEvent.region")}} | {{Spec2('HTML WHATWG')}} | Ajout de la propriété `region` à partir de {{SpecName('DOM3 Events')}}. |
| {{SpecName('Pointer Lock','#extensions-to-the-mouseevent-interface','MouseEvent')}} | {{Spec2('Pointer Lock')}} | À partir de {{SpecName('DOM3 Events')}}, ajout des propriétés `movementX` et `movementY`. |
| {{SpecName('CSSOM View', '#extensions-to-the-mouseevent-interface', 'MouseEvent')}} | {{Spec2('CSSOM View')}} | À partir de {{SpecName('DOM3 Events')}}, ajout des propriétés `offsetX` et `offsetY`, `pageX` et `pageY`, `x` et `y`. Redéfinition de l'écran, de la page, du client et des propriétés des coordonnées (x et y) comme `double` et non plus `long`. |
| {{SpecName('DOM3 Events','#events-mouseevents','MouseEvent')}} | {{Spec2('DOM3 Events')}} | À partir de {{SpecName('DOM2 Events')}}, ajout du constructeur `MouseEvent()`, de la méthode `getModifierState()` et de la propriété `buttons`. |
| {{SpecName('DOM2 Events','#Events-MouseEvent','MouseEvent')}} | {{Spec2('DOM2 Events')}} | Définition initiale. |
## Compatibilité des navigateurs
{{Compat("api.MouseEvent")}}
## Voir aussi
- Son parent direct, {{domxref("UIEvent")}}.
- {{domxref("PointerEvent")}} : Pour les événements avancés du pointeur, y compris le multi-touch.
|
