EventHelper - Cesium Documentation

# EventHelper

#### new EventHelper()

  A convenience object that simplifies the common pattern of attaching event listeners to several events, then removing all those listeners at once later, for example, in a destroy method.

  ##### Example:

      var helper = new Cesium.EventHelper();

      helper.add(someObject.event, listener1, this);
      helper.add(otherObject.event, listener2, this);

      // later...
      helper.removeAll();

  ##### See:

  - Event
  Source: Core/EventHelper.js, line 29

### Methods

#### add(event, listener, scope) → EventHelper~RemoveCallback

  Adds a listener to an event, and records the registration to be cleaned up later.

  Name | Type | Description
  --- | --- | ---
  `event` | Event | The event to attach to.
  `listener` | function | The function to be executed when the event is raised.
  `scope` | Object | optional An optional object scope to serve as the `this` pointer in which the listener function will execute.

  ##### Returns:

  A function that will remove this event listener when invoked.

  ##### See:

  - Event#addEventListener
  Source: Core/EventHelper.js, line 44

#### removeAll()

  Unregisters all previously added listeners.

  ##### See:

  - Event#removeEventListener
  Source: Core/EventHelper.js, line 67

### Type Definitions

#### RemoveCallback()

  A function that removes a listener.
  Source: Core/EventHelper.js, line 75