Class Overlay

Classdesc

An element to be displayed over the map and attached to a single map location. 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);

Param: options

Overlay options.

Api

stable

Hierarchy

Constructors

constructor

Methods

changed dispatchEvent get getElement getId getKeys getMap getOffset getPosition getPositioning getProperties getRevision on once set setElement setMap setOffset setPosition setPositioning setProperties un unByKey unset unByKey

Constructors

constructor

  • new Overlay(options): Overlay

  • Parameters

    Returns Overlay

    Classdesc

    An element to be displayed over the map and attached to a single map location. 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);

    Api

    stable

Methods

changed

  • changed(): void

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

    Returns void

    Api

dispatchEvent

  • dispatchEvent(event): void

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

    Parameters

    Returns void

    Function

    Api

get

  • get(key): any

  • Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

    stable

getElement

  • getElement(): Element

  • Get the DOM element of this overlay.

    Returns Element

    The Element containing the overlay.

    Observable

    Api

    stable

getId

  • getId(): string | number

  • Get the overlay identifier which is set on constructor.

    Returns string | number

    Id.

    Api

getKeys

  • getKeys(): string[]

  • Get a list of object property names.

    Returns string[]

    List of property names.

    Api

    stable

getMap

  • getMap(): Map

  • Get the map associated with this overlay.

    Returns Map

    The map that the overlay is part of.

    Observable

    Api

    stable

getOffset

  • getOffset(): number[]

  • Get the offset of this overlay.

    Returns number[]

    The offset.

    Observable

    Api

    stable

getPosition

  • getPosition(): Coordinate

  • Get the current position of this overlay.

    Returns Coordinate

    The spatial point that the overlay is anchored at.

    Observable

    Api

    stable

getPositioning

  • getPositioning(): OverlayPositioning

  • Get the current positioning of this overlay.

    Returns OverlayPositioning

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

    Observable

    Api

    stable

getProperties

  • getProperties(): {
        [k: string]: any;
    }

  • Get an object of all property names and values.

    Returns {
        [k: string]: any;
    }

    Object.

    • [k: string]: any

    Api

    stable

getRevision

  • getRevision(): number

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

    Returns number

    Revision.

    Api

on

  • on(type, listener, opt_this?): Object | Object[]

  • Listen for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

once

  • once(type, listener, opt_this?): Object | Object[]

  • Listen once for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object to use as this in listener.

    Returns Object | Object[]

    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.

    Api

    stable

set

  • set(key, value, opt_silent?): void

  • Sets a value.

    Parameters

    • key: string

      Key name.

    • value: any

      Value.

    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

setElement

  • setElement(element): void

  • Set the DOM element to be associated with this overlay.

    Parameters

    • element: Element

      The Element containing the overlay.

    Returns void

    Observable

    Api

    stable

setMap

  • setMap(map): void

  • Set the map to be associated with this overlay.

    Parameters

    • map: Map

      The map that the overlay is part of.

    Returns void

    Observable

    Api

    stable

setOffset

  • setOffset(offset): void

  • Set the offset for this overlay.

    Parameters

    • offset: number[]

      Offset.

    Returns void

    Observable

    Api

    stable

setPosition

  • setPosition(position): void

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

    Parameters

    • position: Coordinate

      The spatial point that the overlay is anchored at.

    Returns void

    Observable

    Api

    stable

setPositioning

  • setPositioning(positioning): void

  • Set the positioning for this overlay.

    Parameters

    • positioning: OverlayPositioning

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

    Returns void

    Observable

    Api

    stable

setProperties

  • setProperties(values, opt_silent?): void

  • 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).

    Parameters

    • values: {
          [k: string]: any;
      }

      Values.

      • [k: string]: any
    • Optional opt_silent: boolean

      Update without triggering an event.

    Returns void

    Api

    stable

un

  • un(type, listener, opt_this?): void

  • Unlisten for a certain type of event.

    Parameters

    • type: string | string[]

      The event type or array of event types.

    • listener: Function

      The listener function.

    • Optional opt_this: Object

      The object which was used as this by the listener.

    Returns void

    Api

    stable

unByKey

  • unByKey(key): void

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

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Function

    Api

    stable

unset

  • unset(key, opt_silent?): void

  • Unsets a property.

    Parameters

    • key: string

      Key name.

    • Optional opt_silent: boolean

      Unset without triggering an event.

    Returns void

    Api

    stable

Static unByKey

  • unByKey(key): void

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

    Parameters

    • key: Object | Object[]

      The key returned by on() or once() (or an array of keys).

    Returns void

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc