new ol.Overlay(options)
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Overlay options.
|
Fires:
-
change:element
(ol.ObjectEvent) -
change:map
(ol.ObjectEvent) -
change:offset
(ol.ObjectEvent) -
change:position
(ol.ObjectEvent) -
change:positioning
(ol.ObjectEvent) -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
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
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getElement(){Element|undefined}
src/ol/overlay.js, line 185 -
Get the DOM element of this overlay.
Returns:
The Element containing the overlay.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getMap(){ol.Map|undefined}
src/ol/overlay.js, line 197 -
Get the map associated with this overlay.
Returns:
The map that the overlay is part of.
-
getOffset(){Array.<number>}
src/ol/overlay.js, line 209 -
Get the offset of this overlay.
Returns:
The offset.
-
getPosition(){ol.Coordinate|undefined}
src/ol/overlay.js, line 222 -
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 235 -
Get the current positioning of this overlay.
Returns:
How the overlay is positioned relative to its point on the map.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
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
inlistener
.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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setElement(element)
src/ol/overlay.js, line 320 -
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 331 -
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 342 -
Set the offset for this overlay.
Name Type Description offset
Array.<number> Offset.
-
setPosition(position)
src/ol/overlay.js, line 355 -
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 452 -
Set the positioning for this overlay.
Name Type Description positioning
ol.OverlayPositioning how the overlay is positioned relative to its point on the map.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
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.
-
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.