Class: Overlay

ol.Overlay

Like ol.control.Control, Overlays are visible widgets. Unlike Controls, they are not in a fixed position on the screen, but are tied to a geographical coordinate, so panning the map will move an Overlay but not a Control.

Example:

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

new ol.Overlay(options)

src/ol/overlay.js, line 72
Name Type Description
options

Overlay options.

Name Type Description
element Element | undefined

The overlay element.

offset Array.<number> | undefined

Offsets in pixels used when positioning the overlay. The fist element in the array is the horizontal offset. A positive value shifts the overlay right. The second element in the array is the vertical offset. A positive value shifts the overlay down. Default is [0, 0].

position ol.Coordinate | undefined

The overlay position in map projection.

positioning ol.OverlayPositioning | string | undefined

Defines how the overlay is actually positioned with respect to its position property. Possible values are 'bottom-left', 'bottom-center', 'bottom-right', 'center-left', 'center-center', 'center-right', 'top-left', 'top-center', and 'top-right'. Default is 'top-left'.

stopEvent boolean | undefined

Whether event propagation to the map viewport should be stopped. Default is true. If true the overlay is placed in the same container as that of the controls (CSS class name ol-overlaycontainer-stopevent); if false it is placed in the container with CSS class name ol-overlaycontainer.

insertFirst boolean | undefined

Whether the overlay is inserted first in the overlay container, or appended. Default is true. If the overlay is placed in the same container as that of the controls (see the stopEvent option) you will probably set insertFirst to true so the overlay is displayed below the controls.

Fires:

Extends

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.

offset Array.<number> yes change:offset

The offset.

position ol.Coordinate | undefined 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

getElement(){Element|undefined}

src/ol/overlay.js, line 182

Get the DOM element of this overlay.

Returns:
The Element containing the overlay.

getMap(){ol.Map|undefined}

src/ol/overlay.js, line 198

Get the map associated with this overlay.

Returns:
The map that the overlay is part of.

getOffset(){Array.<number>}

src/ol/overlay.js, line 214

Get the offset of this overlay.

Returns:
The offset.

getPosition(){ol.Coordinate|undefined}

src/ol/overlay.js, line 231

Get the current position of this overlay.

Returns:
The spatial point that the overlay is anchored at.

getPositioning(){ol.OverlayPositioning}

src/ol/overlay.js, line 248

Get the current positioning of this overlay.

Returns:
How the overlay is positioned relative to its point on the map.

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

src/ol/observable.js, line 75

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

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

src/ol/observable.js, line 88

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

setElement(element)

src/ol/overlay.js, line 337

Set the DOM element to be associated with this overlay.

Name Type Description
element Element | undefined

The Element containing the overlay.

setMap(map)

src/ol/overlay.js, line 352

Set the map to be associated with this overlay.

Name Type Description
map ol.Map | undefined

The map that the overlay is part of.

setOffset(offset)

src/ol/overlay.js, line 367

Set the offset for this overlay.

Name Type Description
offset Array.<number>

Offset.

setPosition(position)

src/ol/overlay.js, line 384

Set the position for this overlay. If the position is undefined the overlay is hidden.

Name Type Description
position ol.Coordinate | undefined

The spatial point that the overlay is anchored at.

setPositioning(positioning)

src/ol/overlay.js, line 483

Set the positioning for this overlay.

Name Type Description
positioning ol.OverlayPositioning

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

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().