Class: Overlay

ol/Overlay~Overlay


import Overlay from 'ol/Overlay';

An element to be displayed over the map and attached to a single map location. Like module:ol/control/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:

import Overlay from 'ol/Overlay';

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

new Overlay(options)

Overlay.js, line 101
Name Type Description
options

Overlay options.

Name Type Default Description
id number | string

Set the overlay id. The overlay id can be used with the module:ol/Map~Map#getOverlayById method.

element Element

The overlay element.

offset Array.<number> [0, 0]

Offsets in pixels used when positioning the overlay. The first 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.

position module:ol/coordinate~Coordinate

The overlay position in map projection.

positioning module:ol/OverlayPositioning 'top-left'

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

stopEvent boolean true

Whether event propagation to the map viewport should be stopped. 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 specified by the className property.

insertFirst boolean true

Whether the overlay is inserted first in the overlay container, or appended. 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.

autoPan boolean false

If set to true the map is panned when calling setPosition, so that the overlay is entirely visible in the current viewport.

autoPanAnimation module:ol/Overlay~PanOptions

The animation options used to pan the overlay into view. This animation is only used when autoPan is enabled. A duration and easing may be provided to customize the animation.

autoPanMargin number 20

The margin (in pixels) between the overlay and the borders of the map when autopanning.

className string 'ol-overlay-container ol-selectable'

CSS class name.

Fires:

Extends

Observable Properties

Name Type Settable ol/Object~ObjectEvent type Description
element Element | undefined yes change:element

The Element containing the overlay.

map module:ol/PluggableMap~PluggableMap | undefined yes change:map

The map that the overlay is part of.

offset Array.<number> yes change:offset

The offset.

position module:ol/coordinate~Coordinate | undefined yes change:position

The spatial point that the overlay is anchored at.

positioning module:ol/OverlayPositioning yes change:positioning

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

Methods

changed() inherited

Observable.js, line 59

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited

Observable.js, line 76

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | module:ol/events/Event~Event | string

Event object.

get(key){*} inherited

Object.js, line 136

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getElement(){Element|undefined}

Overlay.js, line 225

Get the DOM element of this overlay.

Returns:
The Element containing the overlay.

getId(){number|string|undefined}

Overlay.js, line 235

Get the overlay identifier which is set on constructor.

Returns:
Id.

getKeys(){Array.<string>} inherited

Object.js, line 150

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap|undefined}

Overlay.js, line 247

Get the map associated with this overlay.

Returns:
The map that the overlay is part of.

getOffset(){Array.<number>}

Overlay.js, line 260

Get the offset of this overlay.

Returns:
The offset.

getPosition(){module:ol/coordinate~Coordinate|undefined}

Overlay.js, line 272

Get the current position of this overlay.

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

getPositioning(){module:ol/OverlayPositioning}

Overlay.js, line 286

Get the current positioning of this overlay.

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

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

Object.js, line 160

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 85

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 99

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.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 122

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.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

Object.js, line 185

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setElement(element)

Overlay.js, line 371

Set the DOM element to be associated with this overlay.

Name Type Description
element Element | undefined

The Element containing the overlay.

setMap(map)

Overlay.js, line 383

Set the map to be associated with this overlay.

Name Type Description
map module:ol/PluggableMap~PluggableMap | undefined

The map that the overlay is part of.

setOffset(offset)

Overlay.js, line 394

Set the offset for this overlay.

Name Type Description
offset Array.<number>

Offset.

setPosition(position)

Overlay.js, line 407

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

Name Type Description
position module:ol/coordinate~Coordinate | undefined

The spatial point that the overlay is anchored at.

setPositioning(positioning)

Overlay.js, line 497

Set the positioning for this overlay.

Name Type Description
positioning module:ol/OverlayPositioning

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

setProperties(values, opt_silent) inherited

Object.js, line 205

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 142

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.

unset(key, opt_silent) inherited

Object.js, line 218

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.