This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/platform-browser

EventManager

An injectable service that provides event management for Angular through a browser plug-in.

      
      class EventManager {
  constructor(plugins: EventManagerPlugin[], _zone: NgZone)
  addEventListener(element: HTMLElement, eventName: string, handler: Function): Function
  addGlobalEventListener(target: string, eventName: string, handler: Function): Function
  getZone(): NgZone
}

Constructor

Initializes an instance of the event-manager service.
constructor(plugins: EventManagerPlugin[], _zone: NgZone)
      
      constructor(plugins: EventManagerPlugin[], _zone: NgZone)

Parameters

plugins

Type: EventManagerPlugin[].
_zone

Type: NgZone.

Methods

addEventListener()

Registers a handler for a specific element and event.
addEventListener(element: HTMLElement, eventName: string, handler: Function): Function
      
      addEventListener(element: HTMLElement, eventName: string, handler: Function): Function

Parameters

element

The HTML element to receive event notifications.
eventName

The name of the event to listen for.
handler

A function to call when the notification occurs. Receives the event object as an argument.

Returns

Function: A callback function that can be used to remove the handler.

addGlobalEventListener()

Registers a global handler for an event in a target view.
addGlobalEventListener(target: string, eventName: string, handler: Function): Function
      
      addGlobalEventListener(target: string, eventName: string, handler: Function): Function

Parameters

target

A target for global event notifications. One of "window", "document", or "body".
eventName

The name of the event to listen for.
handler

A function to call when the notification occurs. Receives the event object as an argument.

Returns

Function: A callback function that can be used to remove the handler.

getZone()

Retrieves the compilation zone in which event listeners are registered.
getZone(): NgZone
      
      getZone(): NgZone

Parameters

There are no parameters.

Returns

NgZone