OpenLayers 3 API Documentation

new Overlay

Stability: stable

An element to show on top of the map, such as for a popup.

Example:

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

Parameters:

Name	Type	Description
`options`	olx.OverlayOptions	Overlay options.

Source:

overlay.js, line 67

Fires:

ol.ObjectEvent ol.event:ObjectEvent

Extends

ol.Object

Observable Properties

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

Methods

bindTo Stability: experimental

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;
    }
  );

Parameters:

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

Inherited From:

ol.Object#bindTo

Source:

object.js, line 242

Returns:

Type: ol.ObjectAccessor

dispatchChangeEvent Stability: experimental

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

Inherited From:

ol.Observable#dispatchChangeEvent

Source:

observable.js, line 39

Fires:

event:change

get Stability: experimental

Gets a value.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#get

Source:

object.js, line 299

Returns:

Value.

Type: *

getElement Stability: experimental

Get the DOM element of this overlay.

Source:

overlay.js, line 162

Returns:

Element.

Type: Element | undefined

getMap Stability: experimental

Get the map associated with this overlay.

Source:

overlay.js, line 177

Returns:

Map.

Type: ol.Map | undefined

getPosition Stability: experimental

Get the current position of this overlay.

Source:

overlay.js, line 192

Returns:

Position.

Type: ol.Coordinate | undefined

getPositioning Stability: experimental

Get the current positioning of this overlay.

Source:

overlay.js, line 207

Returns:

Positioning.

Type: ol.OverlayPositioning | undefined

getProperties Stability: experimental

Get an object of all property names and values.

Inherited From:

ol.Object#getProperties

Source:

object.js, line 358

Returns:

Object.

Type: Object.<string, *>

notify Stability: experimental

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.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#notify

Source:

object.js, line 378

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`.

Inherited From:

ol.Observable#on

Source:

observable.js, line 62

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`.

Inherited From:

ol.Observable#once

Source:

observable.js, line 75

Returns:

Unique key for the listener.

Type: goog.events.Key

set Stability: experimental

Sets a value.

Parameters:

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

Inherited From:

ol.Object#set

Source:

object.js, line 409

setElement Stability: experimental

Set the DOM element to be associated with this overlay.

Parameters:

Name	Type	Description
`element`	Element \| undefined	Element.

Source:

overlay.js, line 284

setMap Stability: experimental

Set the map to be associated with this overlay.

Parameters:

Name	Type	Description
`map`	ol.Map \| undefined	Map.

Source:

overlay.js, line 298

setPosition Stability: stable

Set the position for this overlay.

Parameters:

Name	Type	Description
`position`	ol.Coordinate \| undefined	Position.

Source:

overlay.js, line 312

setPositioning Stability: experimental

Set the positioning for this overlay.

Parameters:

Name	Type	Description
`positioning`	ol.OverlayPositioning \| undefined	Positioning.

Source:

overlay.js, line 326

setValues Stability: experimental

Sets a collection of key-value pairs.

Parameters:

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

Inherited From:

ol.Object#setValues

Source:

object.js, line 438

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`.