MutationEvent: initMutationEvent() 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 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 initMutationEvent() method of the MutationEvent interface initializes the value of a mutation event once it's been created (normally using the Document.createEvent() method).

This method must be called to set the event before it is dispatched, using EventTarget.dispatchEvent().

Note: In general, you won't create these events yourself; they are created by the browser.

Syntax

js
initMutationEvent(type, canBubble, cancelable, relatedNode,
                  prevValue, newValue, attrName, attrChange)

Parameters

type

A string to set the event's type to. Browsers set the following values for MutationEvent: DOMAttrModified, DOMAttributeNameChanged, DOMCharacterDataModified, DOMElementNameChanged, DOMNodeInserted, DOMNodeInsertedIntoDocument, DOMNodeRemoved, DOMNodeRemovedFromDocument, DOMSubtreeModified.

canBubble

A boolean indicating whether or not the event can bubble. Sets the value of Event.bubbles.

cancelable

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

relatedNode

A string representing the new value of the modified node, if any. Sets the value of MutationEvent.relatedNode.

prevValue

A string representing the previous value of the modified node, if any. Sets the value of MutationEvent.prevValue.

newValue

A string representing the new value of the modified node, if any. Sets the value of MutationEvent.newValue.

attrName

A string representing the name of the Attr node changed, if any. Sets the value of MutationEvent.attrName.

attrChange

A integer representing the reason attribute node changed. Sets the value of MutationEvent.attrChange.

Return value

None (undefined).

Specifications

Specification
UI Events
# dom-mutationevent-initmutationevent

Browser compatibility

BCD tables only load in the browser