MouseEvent: initMouseEvent() method
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see thecompatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
TheMouseEvent.initMouseEvent() method initializes thevalue of a mouse event once it's been created (normally using theDocument.createEvent() method).
Warning:Do not use this method anymore as it is deprecated.
Instead use specific event constructors, likeMouseEvent().The section onCreating and dispatching events gives more information about the way to use these.
Events initialized in this way must have been created with theDocument.createEvent() method.This method must be called to set the eventbefore it is dispatched, usingEventTarget.dispatchEvent().
Syntax
initMouseEvent(type, canBubble, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget)Parameters
typethe string to set the event's
typeto. Possible typesfor mouse events include:click,mousedown,mouseup,mouseover,mousemove,mouseout.canBubblewhether or not the event can bubble. Sets the value of
Event.bubbles.cancelablewhether or not the event's default action can be prevented. Sets the value of
Event.cancelable.viewthe event's AbstractView. You should pass the
windowobject here.Sets the value ofUIEvent.view.detailthe event's mouse click count. Sets the value of
UIEvent.detail.screenXthe event's screen x coordinate. Sets the value of
MouseEvent.screenX.screenYthe event's screen y coordinate. Sets the value of
MouseEvent.screenY.clientXthe event's client x coordinate. Sets the value of
MouseEvent.clientX.clientYthe event's client y coordinate. Sets the value of
MouseEvent.clientY.ctrlKeywhether or notcontrol key was pressed during the Event. Sets the valueof
MouseEvent.ctrlKey.altKeywhether or notalt key was pressed during the Event. Sets the value of
MouseEvent.altKey.shiftKeywhether or notshift key was pressed during the Event. Sets the valueof
MouseEvent.shiftKey.metaKeywhether or notmeta key was pressed during the Event. Sets the value of
MouseEvent.metaKey.buttonthe event's mouse
button.relatedTargetthe event'srelated EventTarget. Only usedwith some event types (e.g.,
mouseoverandmouseout). Inother cases, passnull.
Return value
None (undefined).
Examples
const event = document.createEvent("MouseEvents");event.initMouseEvent( "click", true, true, window, 0, 0, 0, 80, 20, false, false, false, false, 0, null,);document.body.dispatchEvent(event);Specifications
| Specification |
|---|
| UI Events # dom-mouseevent-initmouseevent |
Browser compatibility
See also
MouseEvent()constructor, the modernstandard way of creating aMouseEventEvent.initEvent()is a simpler method serving a similar purpose. Itis also obsolete and shouldn't be used any more.