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 tableat 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 the value 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 page onCreating and triggering eventsgives 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 event before it is dispatched, usingEventTarget.dispatchEvent().

Syntax

js
initMouseEvent(type,canBubble,cancelable,view,
detail,screenX,screenY,clientX,clientY,
ctrlKey,altKey,shiftKey,metaKey,
button,relatedTarget)

Parameters

type

the string to set the event'stypeto. Possible types for mouse events include:click,mousedown, mouseup,mouseover,mousemove, mouseout.

canBubble

whether or not the event can bubble. Sets the value ofEvent.bubbles.

cancelable

whether or not the event's default action can be prevented. Sets the value of Event.cancelable.

view

the event's AbstractView. You should pass thewindowobject here. Sets the value ofUIEvent.view.

detail

the event's mouse click count. Sets the value ofUIEvent.detail.

screenX

the event's screen x coordinate. Sets the value of MouseEvent.screenX.

screenY

the event's screen y coordinate. Sets the value of MouseEvent.screenY.

clientX

the event's client x coordinate. Sets the value of MouseEvent.clientX.

clientY

the event's client y coordinate. Sets the value of MouseEvent.clientY.

ctrlKey

whether or notcontrolkey was pressed during the Event. Sets the value ofMouseEvent.ctrlKey.

altKey

whether or notaltkey was pressed during the Event. Sets the value of MouseEvent.altKey.

shiftKey

whether or notshiftkey was pressed during the Event. Sets the value ofMouseEvent.shiftKey.

metaKey

whether or notmetakey was pressed during the Event. Sets the value of MouseEvent.metaKey.

button

the event's mousebutton.

relatedTarget

the event'srelated EventTarget.Only used with some event types (e.g.,mouseoverandmouseout). In other cases, passnull.

Return value

None (undefined).

Examples

HTML

html
<divstyle="background:red;width:180px;padding:10px;">
<divid="out"></div>
<inputtype="text"/>
</div>

JavaScript

js
document.body.onclick=(event)=>{
constelementTag=event.target.tagName.toLowerCase();
document.getElementById("out").textContent=elementTag;
};

constsimulateClick=()=>{
constevent=document.createEvent("MouseEvents");
event.initMouseEvent(
"click",
true,
true,
window,
0,
0,
0,
80,
20,
false,
false,
false,
false,
0,
null,
);
document.body.dispatchEvent(event);
};

simulateClick();

Result

Specifications

This feature is not part of any specification. It is no longer on track to becoming a standard.

Use theMouseEvent()constructor instead.

Browser compatibility

BCD tables only load in the browser

See also