Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The UIEvent.initUIEvent() method initializes a UI event once it's been created.
Events initialized in this way must have been created with the Document.createEvent() method. This method must be called to set the event before it is dispatched, using EventTarget.dispatchEvent(). Once dispatched, it doesn't do anything anymore.
Do not use this method anymore as it is deprecated.
Instead use specific event constructors, like UIEvent(). The page on Creating and triggering events gives more information about the way to use these.
Syntax
event.initUIEvent(type, canBubble, cancelable, view, detail)
Parameters
type- Is a
DOMStringdefining the type of event. canBubble- Is a
Booleandeciding whether the event should bubble up through the event chain or not. Once set, the read-only propertyEvent.bubbleswill give its value. cancelable- Is a
Booleandefining whether the event can be canceled. Once set, the read-only propertyEvent.cancelablewill give its value. view- Is the
WindowProxyassociated with the event. detail- Is an
unsigned longspecifying some detail information about the event, depending on the type of event. For mouse events, it indicates how many times the mouse has been clicked on a given screen location.
Example
var e = document.createEvent("UIEvent");
// creates a click event that bubbles, can be cancelled,
// and with its view and detail property initialized to window and 1,
// respectively
e.initUIEvent("click", true, true, window, 1);
Specifications
| Specification | Status | Comment |
|---|---|---|
| Document Object Model (DOM) Level 3 Events Specification The definition of 'UIEvent.initUIEvent()' in that specification. |
Working Draft | From Document Object Model (DOM) Level 2 Events Specification, deprecated. |
| Document Object Model (DOM) Level 2 Events Specification The definition of 'UIEvent.initUIEvent()' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes) | ? | (Yes) | ? |
| Feature | Android | Edge | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes) | ? | (Yes) | ? |