Event.initEvent()

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 Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

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.

Note: Do not use this method anymore as it is deprecated. Instead use specific event constructors, like Event(). The page on Creating and triggering events gives more information about the way to use these.

Syntax

event.initEvent(type, bubbles, cancelable)

Parameters

type

A string defining the type of event.

bubbles

A boolean value deciding whether the event should bubble up through the event chain or not. Once set, the read-only property Event.bubbles will give its value.

cancelable

A boolean value defining whether the event can be canceled. Once set, the read-only property Event.cancelable will give its value.

Return value

None.

Example

// Create the event.
const event = document.createEvent('Event');

// Create a click event that bubbles up and
// cannot be canceled
event.initEvent('click', true, false);

// Listen for the event.
elem.addEventListener('click', (e) => {
  // e.target matches elem
}, false);

elem.dispatchEvent(event);

Specifications

Specification
DOM Standard
# ref-for-dom-event-initevent①

Browser compatibility

BCD tables only load in the browser

See also

  • The constructor to use instead of this deprecated method: Event(). To create more specific event interfaces than Event, use the constructor defined for the desired event interface.