OpenLayers 3

ol. ol.Observable

new Observable

Stability: experimental

An event target providing convenient methods for listener registration and unregistration. A generic change event is always available through ol.Observable#dispatchChangeEvent.

Source:
  • observable.js, line 19

Extends

  • goog.events.EventTarget

Methods

dispatchChangeEvent

Stability: experimental

Dispatches a change event. Register a listener for this event to get notified of changes.

Source:
  • observable.js, line 39
Fires:
  • event:change

on

Stability: experimental

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Source:
  • observable.js, line 61
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Source:
  • observable.js, line 74
Returns:

Unique key for the listener.

Type
goog.events.Key

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Source:
  • observable.js, line 86

unByKey

Stability: experimental

Removes an event listener using the key returned by on() or once().

Parameters:
Name Type Description
key goog.events.Key

Key.
Source:
  • observable.js, line 96