MouseEvent

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

* Some parts of this feature may have varying levels of support.

Das MouseEvent-Interface repräsentiert Ereignisse, die durch die Interaktion des Benutzers mit einem Zeigegerät (wie einer Maus) auftreten. Häufige Ereignisse, die dieses Interface verwenden, sind click, dblclick, mouseup, mousedown.

MouseEvent leitet sich von UIEvent ab, welches wiederum von Event abgeleitet ist. Obwohl die Methode MouseEvent.initMouseEvent() aus Gründen der Rückwärtskompatibilität beibehalten wird, sollte die Erstellung eines MouseEvent-Objekts mit dem MouseEvent()-Konstruktor erfolgen.

Mehrere spezifischere Ereignisse basieren auf MouseEvent, einschließlich WheelEvent, DragEvent und PointerEvent.

Konstruktor

MouseEvent(): Erstellt ein MouseEvent-Objekt.

Statische Eigenschaften

MouseEvent.WEBKIT_FORCE_AT_MOUSE_DOWN Nicht standardisiert Schreibgeschützt: Minimale Kraft, die für einen normalen Klick erforderlich ist.
MouseEvent.WEBKIT_FORCE_AT_FORCE_MOUSE_DOWN Nicht standardisiert Schreibgeschützt: Minimale Kraft, die für einen Force Click erforderlich ist.

Instanz-Eigenschaften

Dieses Interface erbt auch Eigenschaften seiner Eltern, UIEvent und Event.

MouseEvent.altKey Schreibgeschützt: Gibt true zurück, wenn die alt-Taste beim Auslösen des Mausereignisses gedrückt war.
MouseEvent.button Schreibgeschützt: Die Nummer der Taste, die beim Auslösen des Mausereignisses gedrückt oder losgelassen (sofern zutreffend) wurde.
MouseEvent.buttons Schreibgeschützt: Die Tasten, die beim Auslösen des Mausereignisses gedrückt waren (falls vorhanden).
MouseEvent.clientX Schreibgeschützt: Die X-Koordinate des Mauszeigers in Viewport-Koordinaten.
MouseEvent.clientY Schreibgeschützt: Die Y-Koordinate des Mauszeigers in Viewport-Koordinaten.
MouseEvent.ctrlKey Schreibgeschützt: Gibt true zurück, wenn die control-Taste beim Auslösen des Mausereignisses gedrückt war.
MouseEvent.layerX Nicht standardisiert Schreibgeschützt: Gibt die horizontale Koordinate des Ereignisses relativ zur aktuellen Ebene zurück.
MouseEvent.layerY Nicht standardisiert Schreibgeschützt: Gibt die vertikale Koordinate des Ereignisses relativ zur aktuellen Ebene zurück.
MouseEvent.metaKey Schreibgeschützt: Gibt true zurück, wenn die meta-Taste beim Auslösen des Mausereignisses gedrückt war.
MouseEvent.movementX Schreibgeschützt: Die X-Koordinate des Mauszeigers relativ zur Position des letzten mousemove-Ereignisses.
MouseEvent.movementY Schreibgeschützt: Die Y-Koordinate des Mauszeigers relativ zur Position des letzten mousemove-Ereignisses.
MouseEvent.offsetX Schreibgeschützt: Die X-Koordinate des Mauszeigers relativ zur Position des Innenrandes des Zielknotens.
MouseEvent.offsetY Schreibgeschützt: Die Y-Koordinate des Mauszeigers relativ zur Position des Innenrandes des Zielknotens.
MouseEvent.pageX Schreibgeschützt: Die X-Koordinate des Mauszeigers relativ zum gesamten Dokument.
MouseEvent.pageY Schreibgeschützt: Die Y-Koordinate des Mauszeigers relativ zum gesamten Dokument.
MouseEvent.relatedTarget Schreibgeschützt: Das sekundäre Ziel des Ereignisses, falls vorhanden.
MouseEvent.screenX Schreibgeschützt: Die X-Koordinate des Mauszeigers in Bildschirmkoordinaten.
MouseEvent.screenY Schreibgeschützt: Die Y-Koordinate des Mauszeigers in Bildschirmkoordinaten.
MouseEvent.shiftKey Schreibgeschützt: Gibt true zurück, wenn die shift-Taste beim Auslösen des Mausereignisses gedrückt war.
MouseEvent.mozInputSource Nicht standardisiert Schreibgeschützt: Der Typ des Geräts, das das Ereignis erzeugt hat (einer der MOZ_SOURCE_*-Konstanten). Damit können Sie beispielsweise feststellen, ob ein Mausereignis durch eine tatsächliche Maus oder durch ein Touch-Ereignis erzeugt wurde (was die Genauigkeit beeinflussen könnte, mit der Sie die mit dem Ereignis verknüpften Koordinaten interpretieren).
MouseEvent.webkitForce Nicht standardisiert Schreibgeschützt: Der Druck, der beim Klicken ausgeübt wird.
MouseEvent.x Schreibgeschützt: Alias für MouseEvent.clientX.
MouseEvent.y Schreibgeschützt: Alias für MouseEvent.clientY.

Instanz-Methoden

Dieses Interface erbt auch Methoden seiner Eltern, UIEvent und Event.

MouseEvent.getModifierState(): Gibt den aktuellen Zustand der angegebenen Modifizierertaste zurück. Siehe KeyboardEvent.getModifierState() für Details.
MouseEvent.initMouseEvent() Veraltet: Initialisiert den Wert eines erstellten MouseEvent. Falls das Ereignis bereits gesendet wurde, tut diese Methode nichts.

Beispiel

Dieses Beispiel demonstriert die Simulation eines Klicks (programmgesteuertes Erzeugen eines Klickereignisses) auf ein Kontrollkästchen mit DOM-Methoden. Der Zustand des Ereignisses (abgebrochen oder nicht) wird dann mit dem Rückgabewert der Methode EventTarget.dispatchEvent() bestimmt.

HTML

html

<p>
  <label><input type="checkbox" id="checkbox" /> Checked</label>
</p>
<p>
  <button id="button">Click me to send a MouseEvent to the checkbox</button>
</p>

JavaScript

function simulateClick() {
  // Get the element to send a click event
  const cb = document.getElementById("checkbox");

  // Create a synthetic click MouseEvent
  let evt = new MouseEvent("click", {
    bubbles: true,
    cancelable: true,
    view: window,
  });

  // Send the event to the checkbox element
  cb.dispatchEvent(evt);
}
document.getElementById("button").addEventListener("click", simulateClick);

Ergebnis

Spezifikationen

Specification
UI Events # interface-mouseevent
CSSOM View Module # extensions-to-the-mouseevent-interface
Pointer Lock 2.0 # extensions-to-the-mouseevent-interface

Browser-Kompatibilität

Siehe auch

Sein direkter Elternteil, UIEvent
PointerEvent: Für fortgeschrittene Zeigerereignisse, einschließlich Multi-Touch