Interface ImaEventTarget

AI-generated Key Takeaways

• ImaEventTarget is an object that extends EventTarget, allowing listeners for IMA events to be added.

• The addEventListener method appends an event listener for a specified event type with an optional callback and options.

• The dispatchEvent method dispatches a synthetic event to the target and returns a boolean indicating if the default action was prevented.

• The removeEventListener method removes an event listener with matching type, callback, and options from the target's list.

Note: This reference page follows TypeScript documentation structure. If you have suggestions for or see issues with the reference documentation, open a thread with your feedback on the IMA technical forum.

---

Extends EventTarget

An object to which listeners for IMA events can be added.

Methods
addEventListener	Appends an event listener for events whose type attribute value is type.
dispatchEvent	Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
removeEventListener	Removes the event listener in target's event listener list with the same type, callback, and options.

Methods

---

addEventListener

addEventListener(type: string, handler: null | object, capture?: boolean, handlerScope?: null | object): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters
type: string
handler: null | object
Optional capture: boolean
Optional handlerScope: null | object

---

dispatchEvent

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters
event: Event

Returns
boolean

---

removeEventListener

removeEventListener(type: string, handler: null | object, capture?: boolean, handlerScope?: null | object): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters
type: string
handler: null | object
Optional capture: boolean
Optional handlerScope: null | object