Class: Overlay

var popup = new ol.Overlay({
  element: document.getElementById('popup')
});
popup.setPosition(coordinate);
map.addOverlay(popup);

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
element	Element | undefined	yes	change:element	The Element containing the overlay.
map	ol.Map | undefined	yes	change:map	The map that the overlay is part of.
position	ol.Coordinate | undefined	yes	change:position	The spatial point that the overlay is anchored at.
positioning	ol.OverlayPositioning | undefined	yes	change:positioning	How the overlay is positioned relative to its point on the map.

Methods

experimental inherited bindTo(key, target, opt_targetKey){ol.ObjectAccessor}

src/ol/object.js, line 247

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Argument	Description
key	string		Key name.
target	ol.Object		Target.
targetKey	string	<optional>	optional Target key.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

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

Fires:

• change

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental getElement(){Element|undefined}

src/ol/overlay.js, line 160

Get the DOM element of this overlay.

Returns:

Element containing the overlay.

experimental inherited getKeys(){Array.<string>}

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental getMap(){ol.Map|undefined}

src/ol/overlay.js, line 176

Get the map associated with this overlay.

Returns:

map that the overlay is part of.

experimental getPosition(){ol.Coordinate|undefined}

src/ol/overlay.js, line 193

Get the current position of this overlay.

Returns:

spatial point that the overlay is anchored at.

experimental getPositioning(){ol.OverlayPositioning|undefined}

src/ol/overlay.js, line 210

Get the current positioning of this overlay.

Returns:

the overlay is positioned relative to its point on the map.

experimental inherited getProperties(){Object.<string, *>}

src/ol/object.js, line 364

Get an object of all property names and values.

experimental inherited notify(key)

src/ol/object.js, line 384

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Name	Type	Description
key	string	Key name.

experimental inherited on(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 61

Listen for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental setElement(element)

src/ol/overlay.js, line 288

Set the DOM element to be associated with this overlay.

Name	Type	Description
element	Element | undefined	The Element containing the overlay.

experimental setMap(map)

src/ol/overlay.js, line 303

Set the map to be associated with this overlay.

Name	Type	Description
map	ol.Map | undefined	The map that the overlay is part of.

setPosition(position)

src/ol/overlay.js, line 319

Set the position for this overlay.

Name	Type	Description
position	ol.Coordinate | undefined	The spatial point that the overlay is anchored at.

experimental setPositioning(positioning)

src/ol/overlay.js, line 335

Set the positioning for this overlay.

Name	Type	Description
positioning	ol.OverlayPositioning | undefined	how the overlay is positioned relative to its point on the map.

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name	Type	Argument	Description
type	string | Array.<string>		The event type or array of event types.
listener	function		The listener function.
this	Object	<optional>	optional The object to use as this in listener.

experimental inherited unbind(key)

src/ol/object.js, line 458

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

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

Name	Type	Description
key	goog.events.Key	Key.