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 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
DOMString
defining the type of event. canBubble
- Is a
Boolean
deciding whether the event should bubble up through the event chain or not. Once set, the read-only propertyEvent.bubbles
will give its value. cancelable
- Is a
Boolean
defining whether the event can be canceled. Once set, the read-only propertyEvent.cancelable
will give its value. view
- Is the
WindowProxy
associated with the event. detail
- Is an
unsigned long
specifying 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. |
Obsolete | 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. |
Obsolete | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
initUIEvent | Chrome Full support Yes | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari ? | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS ? | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support
- Compatibility unknown
- Compatibility unknown
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.
- Deprecated. Not for use in new websites.