Have Proj4js.
The CSS class that we'll give the DOM elements to have them unselectable.
The CSS class for unsupported feature.
See the class list to the right and especially take a look at ol.Map and ol.layer.Layer because those are the central objects.
+ +In general every use of OpenLayers starts by initializing a map, then adding the required layers. Controls and interactions can be added to change the behavior of the map.
+ +A ol.Projection defines which point on earth is represented by a pair of coordinates. +Coordinates within OpenLayers can be used in various projections where some common projections are always supported, +others can be used via Proj4js.
+ +A map in OpenLayers is essentially a staple of layers that is viewed from the top. Layers are responsible for retieving data and displaying it.
+ +See CONTRIBUTING.md for instructions +on building and tesing OpenLayers. The file does also describe how to commit your changes to OpenLayers.
Create a new attribution to be associated with a layer source.
+ +Example:
+ +source: new ol.source.OSM({
+ attributions: [
+ new ol.Attribution({
+ html: 'All maps © ' +
+ '<a href="http://www.opencyclemap.org/">OpenCycleMap</a>'
+ }),
+ ol.source.OSM.DATA_ATTRIBUTION
+],
+..
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.AttributionOptions + + + + | + + + + + +Attribution options. |
+
A mutable MVC Array.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
array |
+
+
+ + + +Array + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Array. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Remove all elements from the collection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
arr |
+
+
+ + + +Array + + + + | + + + + + +Array. |
+
This collection.
+Iterate over each element, calling the provided callback.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The function to call for every element. This function + takes 3 arguments (the element, the index and the array). The return + value is ignored. |
+
obj |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) The object to be used as the value of 'this' + within f. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get a reference to the underlying Array object. Warning: if the array +is mutated, no events will be dispatched by the collection, and the +collection's "length" property won't be in sync with the actual length +of the array.
+Array.
+Get the element at the provided index.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
Element.
+Get the length of this collection.
+Length.
+Insert an element at the provided index.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
elem |
+
+
+ + + +* + + + + | + + + + + +Element. |
+
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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Remove the last element of the collection.
+Element.
+Insert the provided element at the end of the collection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
elem |
+
+
+ + + +* + + + + | + + + + + +Element. |
+
Length.
+Removes the first occurence of elem from the collection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
elem |
+
+
+ + + +* + + + + | + + + + + +Element. |
+
The removed element or undefined if elem was not found.
+Remove the element at the provided index.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
Value.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Set the element at the provided index.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
elem |
+
+
+ + + +* + + + + | + + + + + +Element. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
The ol.DeviceOrientation class provides access to DeviceOrientation +information and events, see the [HTML 5 DeviceOrientation Specification]( +http://dev.w3.org/geo/api/spec-source-orientation) for more details.
+ +Many new computers, and especially mobile phones +and tablets, provide hardware support for device orientation. Web +developers targetting mobile devices will be especially interested in this +class.
+ +Device orientation data are relative to a common starting point. For mobile +devices, the starting point is to lay your phone face up on a table with the +top of the phone pointing north. This represents the zero state. All +angles are then relative to this state. For computers, it is the same except +the screen is open at 90 degrees.
+ +Device orientation is reported as three angles - alpha, beta, and
+gamma - relative to the starting position along the three planar axes X, Y
+and Z. The X axis runs from the left edge to the right edge through the
+middle of the device. Similarly, the Y axis runs from the bottom to the top
+of the device through the middle. The Z axis runs from the back to the front
+through the middle. In the starting position, the X axis points to the
+right, the Y axis points away from you and the Z axis points straight up
+from the device lying flat.
The three angles representing the device orientation are relative to the
+three axes. alpha indicates how much the device has been rotated around the
+Z axis, which is commonly interpreted as the compass heading (see note
+below). beta indicates how much the device has been rotated around the X
+axis, or how much it is tilted from front to back. gamma indicates how
+much the device has been rotated around the Y axis, or how much it is tilted
+from left to right.
For most browsers, the alpha value returns the compass heading so if the
+device points north, it will be 0. With Safari on iOS, the 0 value of
+alpha is calculated from when device orientation was first requested.
+ol.DeviceOrientation provides the heading property which normalizes this
+behavior across all browsers for you.
It is important to note that the HTML 5 DeviceOrientation specification
+indicates that alpha, beta and gamma are in degrees while the
+equivalent properties in ol.DeviceOrientation are in radians for consistency
+with all other uses of angles throughout OpenLayers.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.DeviceOrientationOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
Indicates if DeviceOrientation is supported in the user's browser.
+Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+The alpha value of the DeviceOrientation, +in radians.
+The beta value of the DeviceOrientation, +in radians.
+The gamma value of the DeviceOrientation, +in radians.
+The heading of the device relative to +north, in radians, normalizing for different browser behavior.
+Are we tracking the device's orientation?
+The current tracking state, true if tracking is on.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Enable or disable tracking of DeviceOrientation events.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean + + + + | + + + + + +True to enable and false to disable tracking. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Create a new feature. A feature is the base entity for vectors and has +attributes, including normally a geometry attribute.
+ +Example:
+ +var feature = new ol.Feature({'foo': 'bar'});
+feature.setGeometry(new ol.geom.Point([100, 500]));
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
values |
+
+
+ + + +Object.<string, *>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Attributes. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Gets a copy of the attributes of this feature.
+Attributes object.
+Returns the feature's commonly used identifier. This identifier is usually +the unique id in the source store.
+The feature's identifier.
+Get the geometry associated with this feature.
+The geometry (or null if none).
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Set the geometry to be associated with this feature after its creation.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
geometry |
+
+
+ + + +ol.geom.Geometry + + + + | + + + + + +The geometry. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Helper class for providing HTML5 Geolocation capabilities. +The Geolocation API +is used to locate a user's position.
+ +Example:
+ +var geolocation = new ol.Geolocation();
+// take the projection to use from the map's view
+geolocation.bindTo('projection', map.getView());
+// listen to changes in position
+geolocation.on('change:position', function(evt) {
+ window.console.log(geolocation.getPosition());
+});
+mapRendereroptionslayerOptions.
Is HTML5 geolocation supported in the current browser?
+Binds a View to a Model.
+Key.
Target.
Target key.
No notify.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
isLoadedFunction |
-
-
- - - -function(ol.Tile): boolean - - - - | - - - - - -Function to - determine if the tile is loaded. | -
tileSource |
-
-
- - - -ol.source.TileSource - - - - | - - - - - -Tile source. | -
tileGrid |
-
-
- - - -ol.tilegrid.TileGrid - - - - | - - - - - -Tile grid. | -
projection |
-
-
- - - -ol.Projection - - - - | - - - - - -Projection. | -
Gets a value.
+Key.
Value.
Get the accuracy of the position in meters.
accuracy in meters.
Get the altitude associated with the position.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
event |
-
-
- - - -goog.events.Event - - - - | - - - - - -Image change event. | -
The altitude in meters above the mean sea level.
+Get the altitude accuracy of the position.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
tile |
-
-
-
-
-
-ol.Tile
+
+
+
+Altitude accuracy. +
|
-
-
-
-
-
- Tile. | -
Get the heading as radians clockwise from North.
+Heading.
+Get the position of the device.
+position.
+Get the projection associated with the position.
+projection.
+Get the speed in meters per second.
+Speed.
+Are we tracking the user's position?
+tracking.
+Get the tracking options.
+HTML 5 Gelocation +tracking options.
+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.
+Key.
Listen for a certain type of event.
+frameStatetypeThe event type or array of event types.
tileSourcelistenerThe listener function.
scopeObject is whose scope to call + the listener.
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+Key.
Value.
Set the projection to use for transforming the coordinates.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Projection. |
+
Enable/disable tracking.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean + + + + | + + + + + +Enable or disable tracking. |
+
Set the tracking options.
+HTML 5 Geolocation +tracking options.
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +|
|---|---|---|---|
values |
+
+
+ + + Object.<string, *> @@ -2341,7 +2493,7 @@ - | Options. | +Values. |
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+Key.
Removes all bindings.
Removes an event listener which was added with listen() by the key returned + by on().
+attributionsSetattributions| Name | - - -Type | - +Argument | @@ -2748,53 +2969,7 @@||
|---|---|---|---|---|
usedTiles |
-
-
- - - -Object.<string, Object.<string, ol.TileRange>> - - - - | - - - - - -Used tiles. | -||
tileSource |
-
-
- - - -ol.source.TileSource - - - - | - - - - - -Tile source. | -||
z |
+ key |
@@ -2807,33 +2982,18 @@ | - - - -Z. | -|
tileRange |
-
-
- - + | -ol.TileRange - - - - | + + + <nullable>Tile range. | +Key. |
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
wantedTiles |
-
-
- - - -Object.<string, Object.<string, boolean>> - - - - | - - - - - -Wanted tiles. | -
tileSource |
-
-
- - - -ol.source.TileSource - - - - | - - - - - -Tile source. | -
tileCoord |
-
-
- - - -ol.TileCoord - - - - | - - - - - -Tile coordinate. | -
The map is the core component of OpenLayers. In its minimal configuration it +needs a view, one or more layers, and a target container:
+ +var map = new ol.Map({
+ view: new ol.View2D({
+ center: [0, 0],
+ zoom: 1
+ }),
+ layers: [
+ new ol.layer.Tile({
+ source: new ol.source.MapQuestOSM()
+ })
+ ],
+ target: 'map'
+});
+The above snippet creates a map with a MapQuest OSM layer on a 2D view and +renders it to a DOM element with the id 'map'.
mapOptionsoptionsMap options.
Add the given control to the map.
+mapOptionscontrolControl.
Adds the given layer to the top of this map.
+Layer.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
preRenderFunction |
-
-
- - - -ol.PreRenderFunction - - - - | - - - - - -Pre-render function. | -
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
preRenderFunctions |
-
-
- - - -Array.<ol.PreRenderFunction> - - - - | - - - - - -Pre-render functions. | -
| Name | - - -Type | - - -Argument | - - - - -Description | -
|---|---|---|---|
key |
-
-
- - - -string - - - - | - - -- - - - | - - - - -Key. | -
target |
-
-
- - - -ol.Object - - - - | - - -- - - - | - - - - -Target. | -
targetKey |
-
-
- - - -string= - - - - | - - -
-
- <optional> - - - - |
-
-
-
-
- (Optional) Target key. | -
noNotify |
-
-
- - - -boolean= - - - - | - - -
-
- <optional> - - - - |
-
-
-
-
- (Optional) No notify. | -
Add the given overlay to the map.
keyoverlayOverlay.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
pixel |
-
-
- - - -ol.Pixel - - - - | - - - - - -Pixel. | -
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
coordinate |
-
-
- - - -ol.Coordinate - - - - | - - - - - -Coordinate. | -
Add functions to be called before rendering. This can be used for attaching +animations before updating the map's view. The ol.animation +namespace provides several static methods for creating prerender functions.
+tilevar_argstileSourceKeytileCenterAny number of pre-render functions.
Binds a View to a Model.
+browserEventkeyKey.
typetargetTarget.
targetKeyTarget key.
| Name | - - -Type | - - - - - -Description | -|||
|---|---|---|---|---|---|
mapBrowserEvent |
+ noNotify |
-ol.MapBrowserEvent +boolean | +
+
+ <optional> + + + + |
- The event to handle. | + +(Optional) No notify. |
Key. | +Key. |
+
+
+
+
Value.
+Controls.
+Get feature information for a pixel on the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.GetFeatureInfoOptions + + + + | + + + + + +Options. |
+
Get features for a pixel on the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.GetFeaturesOptions + + + + | + + + + + +Options. |
+
Gets the collection on interactions associated with this map. +Interactions are used for e.g. pan, zoom and rotate.
+Interactions.
+Get the layergroup associated with this map.
+LayerGroup.
+Get the collection of layers associated with this map.
+Layers.
+Overlays.
+Get the map's renderer.
+Renderer.
+Get the size of this map.
+Size.
+Get the element in which this map is rendered.
+Target.
+Get the view associated with this map. This can be a 2D or 3D view. A 2D +view manages properties such as center and resolution.
+View.
+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.
+| Name | + + +Type | + + + + + +Description | +|||
|---|---|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Remove the given control from the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
control |
+
+
+ + + +ol.control.Control + + + + | + + + + + +Control. |
+
The removed control of undefined + if the control was not found.
+Removes the given layer from the map.
+Layer.
The removed layer or undefined if the + layer was not found.
Remove the given overlay from the map.
+preRenderFunctionoverlayOverlay.
The removed overlay of undefined + if the overlay was not found.
Sets a value.
+Key.
Value.
Sets the layergroup of this map.
+backgroundColorlayerGroupLayergroup.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
layers |
-
-
- - - -ol.Collection - - - - | - - - - - -Layers. | -
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
options |
-
-
- - - -Object.<string, *> - - - - | - - - - - -Options. | -
Set the size of this map.
+Size.
Set the target element to render this map into.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
target |
+
+
+ + + +Element +| + +string +| + +undefined + + + + | + + + + + +Target. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Set the view for this map.
+View.
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+Key.
Removes all bindings.
Removes an event listener which was added with listen() by the key returned + by on().
fkeyobjKey.
Force a recalculation of the map viewport size. This should be called when +third-party code changes the size of the map viewport.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Event type. |
+
map |
+
+
+ + + +ol.Map + + + + | + + ++ + + + | + + + + +Map. |
+
browserEvent |
+
+
+ + + +goog.events.BrowserEvent + + + + | + + ++ + + + | + + + + +Browser event. |
+
frameState |
+
+
+ + + +ol.FrameState + + + + | + + +
+
+ <optional> + + + + <nullable> + + |
+
+
+
+
+ (Optional) Frame state. |
+
Coordinate.
+Get pixel offset of the event from the top-left corner of the map viewport.
+Pixel offset.
+Base class implementing KVO (Key Value Observing).
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
values |
+
+
+ + + +Object.<string, *>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Values. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
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);
+anchoredElementOptionsoptionsOverlay options.
Binds a View to a Model.
+Key.
Target.
Target key.
No notify.
Gets a value.
+Key.
Value.
Get the DOM element of this overlay.
+Element.
Get the map associated with this overlay.
Map.
Get the current position of this overlay.
+Position.
Get the current positioning of this overlay.
+Positioning.
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.
+Key.
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+Key.
Value.
Set the DOM element to be associated with this overlay.
+Element.
Set the map to be associated with this overlay.
+Map.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
options |
-
-
- - - -Object.<string, *> - - - - | - - - - - -Options. | -
Set the position for this overlay.
+Position.
Sets a collection of key-value pairs.
+positioningvaluesValues.
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+Key.
Removes all bindings.
Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.ProjectionOptions + + + + | + + + + + +Projection options. |
+
Get the resolution of the point in degrees. For projections with degrees as +the unit this will simply return the provided resolution. For other +projections the point resolution is estimated by transforming the center +pixel to EPSG:4326, measuring its width and height on the normal sphere, +and taking the average of the width and height.
+Get the axis orientation of this projection. +Example values are: +enu - the default easting, northing, elevation. +neu - northing, easting, up - useful for "lat/long" geographic coordinates, + or south orientated transverse mercator. +wnu - westing, northing, up - some planetary coordinate systems have + "west positive" coordinate systems
+Axis orientation.
+Get the code for this projection, e.g. 'EPSG:4326'.
+Code.
+Get the validity extent for this projection.
+Extent.
+Get the amount of meters per unit of this projection. If the projection is
+not configured with a units identifier, the return is undefined.
Meters.
+Get the units of this projection.
+Units.
+Is this projection a global projection which spans the whole world?
+Wether the projection is global.
+An ol.View2D object represents a simple 2D view of the map.
+ +This is the object to act upon to change the center, resolution, +and rotation of the map.
+ +An ol.View2D is determined by three states: center, resolution,
+and rotation. To each state corresponds a getter and a setter. E.g.
+getCenter and setCenter for the center state.
An ol.View2D has a projection. The projection determines the
+coordinate system of the center, and its units determine the units of the
+resolution (projection units per pixel). The default projection is
+Spherical Mercator (EPSG:3857).
setCenter, setResolution and setRotation can be used to change the
+states of the view. Any value can be passed to the setters. And the value
+that is passed to a setter will effectively be the value set in the view,
+and returned by the corresponding getter.
But an ol.View2D object also has a resolution constraint and a
+rotation constraint. There's currently no center constraint, but
+this may change in the future.
As said above no constraints are applied when the setters are used to set
+new states for the view. Applying constraints is done explicitly through
+the use of the constrain* functions (constrainResolution and
+constrainRotation).
The main users of the constraints are the interactions and the +controls. For example, double-clicking on the map changes the view to +the "next" resolution. And releasing the fingers after pinch-zooming +snaps to the closest resolution (with an animation).
+ +So the resolution constraint snaps to specific resolutions. It is
+determined by the following options: resolutions, maxResolution,
+maxZoom, and zoomFactor. If resolutions is set, the other three
+options are ignored. See ol.View2DOptions for more information.
The rotation constaint is currently not configurable. It snaps the +rotation value to zero when approaching the horizontal.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.View2DOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) View2D options. |
+
Calculate the extent for the given size in pixels, based on the current +resolution and the current center.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
size |
+
+
+ + + +ol.Size + + + + | + + + + + +Box pixel size. |
+
Extent.
+Get the constrained the resolution of this view.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
resolution |
+
+
+ + + +number +| + +undefined + + + + | + + ++ + + + | + + + + +Resolution. |
+
delta |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Delta. |
+
direction |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Direction. |
+
Constrained resolution.
+Get the constrained rotation of this view.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + ++ + + + | + + + + +Rotation. |
+
delta |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Delta. |
+
Constrained rotation.
+Fit the given extent based on the given map size.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + + + + +Extent. |
+
size |
+
+
+ + + +ol.Size + + + + | + + + + + +Box pixel size. |
+
Get the current zoom level. Return undefined if the current +resolution is undefined or not a "constrained resolution".
+Zoom.
+Set the center of the current view.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
center |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +Center. |
+
Set the projection of this view.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.Projection +| + +undefined + + + + | + + + + + +Projection. |
+
Set the resolution for this view.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
resolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Resolution. |
+
Set the rotation for this view.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Rotation. |
+
Zoom to a specific zoom level.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
zoom |
+
+
+ + + +number + + + + | + + + + + +Zoom level. |
+
The {ol.animation} static methods are designed to be used with the ol.Map#beforeRender method. For example:
+ +var map = new ol.Map({ ... });
+var zoom = ol.animation.zoom({
+ resolution: map.getView().getResolution()
+});
+map.beforeRender(zoom);
+map.getView().setResolution(map.getView().getResolution() * 2);
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.animation.BounceOptions + + + + | + + + + + +Bounce options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.animation.PanOptions + + + + | + + + + + +Pan options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.animation.RotateOptions + + + + | + + + + + +Rotate options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.animation.ZoomOptions + + + + | + + + + + +Zoom options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
resolution |
+
+
+ + + +number + + + + | + + + + + +The resolution to start the bounce from, typically |
+
start |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The start time of the animation. Default is immediately. |
+
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The duration of the animation in milliseconds. Default is 1000. |
+
easing |
+
+
+ + + +function + + + + | + + + + + +The easing function to use. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +The location to start panning from, typically |
+
start |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The start time of the animation. Default is immediately. |
+
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The duration of the animation in milliseconds. Default is 1000. |
+
easing |
+
+
+ + + +function + + + + | + + + + + +The easing function to use. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rotation |
+
+
+ + + +number + + + + | + + + + + +The rotation to apply, in radians. |
+
start |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The start time of the animation. Default is immediately. |
+
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The duration of the animation in milliseconds. Default is 1000. |
+
easing |
+
+
+ + + +function + + + + | + + + + + +The easing function to use. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
resolution |
+
+
+ + + +number + + + + | + + + + + +number The resolution to begin zooming from, typically |
+
start |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The start time of the animation. Default is immediately. |
+
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The duration of the animation in milliseconds. |
+
easing |
+
+
+ + + +function + + + + | + + + + + +Easing function. |
+
Create a new attribution control to show all the attributions associated +with the layer sources in the map. A default map has this control included. +By default it will show in the bottom right portion of the map, but it can +be changed by using a css selector for .ol-attribution.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.AttributionOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Attribution options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Something to be painted over the map to provide a means for interaction +(buttons) or to show annotations (status bars).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.control.ControlOptions + + + + | + + + + + +Control options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Provides a button that when clicked fills up the full screen with the map. +When in full screen mode, a close button is shown to exit full screen mode. +The Fullscreen API is used to +toggle the map in full screen mode.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.FullScreenOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Shows a logo for all the layer sources in the map that have a logo +associated with them, such as Bing. This control is part of a default map. +By default it will show in the bottom-left portion of the map, but it can +be styled by using a css selector for .ol-logo.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.LogoOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Logo options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Create a new control to show the position of the mouse in the map's +projection (or any other supplied projection). By default the control is +shown in the top right corner of the map but this can be changed by using +a css selector .ol-mouse-position.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.MousePositionOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Mouse position options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+projection.
+Get the map associated with this control.
+Map.
+projection.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
format |
+
+
+ + + +ol.CoordinateFormatType + + + + | + + + + + +Coordinate format. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Projection. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Create a control to help users estimate distances on a map.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.ScaleLineOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Scale line options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+units.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
units |
+
+
+ + + +ol.control.ScaleLineUnits + + + + | + + + + + +Units. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Create a new control with 2 buttons, one for zoom in and one for zoom out. +This control is part of the default controls of a map. To style this control +use css selectors .ol-zoom-in and .ol-zoom-out.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.ZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Zoom options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
A slider type of control for zooming.
+ +Example:
+ +map.addControl(new ol.control.ZoomSlider());
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.ZoomSliderOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Zoom slider options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Create a control that adds a button, which, when pressed, changes +the map view to a specific extent. To style this control use the +css selector .ol-zoom-extent.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.ZoomToExtentOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
Binds a View to a Model.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Target key. |
+
noNotify |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) No notify. |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Value.
+Get the map associated with this control.
+Map.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Listen for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Listen once for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Remove the control from its current map and attach it to the new map. +Subclasses may set up event handlers to get notified about changes to +the map here.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
Unlisten for a certain type of event.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key. |
+
Removes all bindings.
+Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
DEGREES |
+
+
+ + + +string + + + + | + + + + ++ + degrees + + | + + ++ |
IMPERIAL |
+
+
+ + + +string + + + + | + + + + ++ + imperial + + | + + ++ |
NAUTICAL |
+
+
+ + + +string + + + + | + + + + ++ + nautical + + | + + ++ |
METRIC |
+
+
+ + + +string + + + + | + + + + ++ + metric + + | + + ++ |
US |
+
+
+ + + +string + + + + | + + + + ++ + us + + | + + ++ |
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.control.DefaultsOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Defaults options. |
+
Controls.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is 'ol-attribution'. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
element |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Element. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attribution |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Attribution. |
+
attributionOptions |
+
+
+ + + +ol.control.AttributionOptions +| + +undefined + + + + | + + + + + +Attribution options. |
+
logo |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Logo. |
+
logoOptions |
+
+
+ + + +ol.control.LogoOptions +| + +undefined + + + + | + + + + + +Logo options. |
+
zoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Zoom. |
+
zoomOptions |
+
+
+ + + +ol.control.ZoomOptions +| + +undefined + + + + | + + + + + +Zoom options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is 'ol-full-screen'. |
+
keys |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Full keyboard access. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is 'ol-logo'. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is 'ol-mouse-position'. |
+
coordinateFormat |
+
+
+ + + +ol.CoordinateFormatType +| + +undefined + + + + | + + + + + +Coordinate + format. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
undefinedHTML |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Markup for undefined coordinates. + Default is '' (empty string). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS Class name. Default is 'ol-scale-line'. |
+
minWidth |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum width in pixels. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
units |
+
+
+ + + +ol.control.ScaleLineUnits +| + +undefined + + + + | + + + + + +Units. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is 'ol-zoom'. |
+
delta |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The zoom delta applied on each click. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum resolution. |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum resolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Class name. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The extent to zoom to. If + undefined the validity extent of the view projection is used. |
+
Helper class for binding HTML input to an ol.Object
+ +Example:
+ +// bind a checkbox with id 'visible' to a layer's visibility
+var visible = new ol.dom.Input(document.getElementById('visible'));
+visible.bindTo('checked', layer, 'visible');
+arraytargetTarget element.
Binds a View to a Model.
+Key.
Target.
Target key.
No notify.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
arr |
-
-
- - - -Array - - - - | - - - - - -Array. | -
| Name | - - -Type | - - -Argument | - - - - -Description | -
|---|---|---|---|
f |
-
-
- - - -Function - - - - | - - -- - - - | - - - - -Function. | -
obj |
-
-
- - - -Object= - - - - | - - -
-
- <optional> - - - - |
-
-
-
-
- (Optional) Object. | -
Gets a value.
+Key.
Value.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
index |
-
-
- - - -number - - - - | - - - - - -Index. | -
If the input is a checkbox, return whether or not the checbox is checked.
checked.
Get the value of the input.
+input value.
Get the value of the input as a number.
+| Name | - - -Type | - - - - - -Description | -
|---|---|---|
index |
-
-
- - - -number - - - - | - - - - - -Index. | -
elem |
-
-
- - - -* - - - - | - - - - - -Element. | -
input value as number.
+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.
+Key.
| Name | - - -Type | - - - - - -Description | -
|---|---|---|
elem |
-
-
- - - -* - - - - | - - - - - -Element. | -
Listen for a certain type of event.
elemtypeThe event type or array of event types.
listenerThe listener function.
scopeObject is whose scope to call + the listener.
Unique key for the listener.
Listen once for a certain type of event.
+indextypeThe event type or array of event types.
listenerThe listener function.
scopeObject is whose scope to call + the listener.
Unique key for the listener.
Sets a value.
+Key.
Value.
Set whether or not a checkbox is checked.
+indexcheckedelemChecked.
Sets the value of the input.
+optionsvalueValue.
Sets the number value of the input.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
value |
+
+
+ + + +number + + + + | + + + + + +Number value. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +|
|---|---|---|---|
values |
@@ -2361,7 +1883,7 @@ - | Options. | +Values. |
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
type |
+
+
+ + + +string +| + +Array.<string> + + + + | + + ++ + + + | + + + + +The event type or array of event types. |
+
listener |
+
+
+ + + +Function + + + + | + + ++ + + + | + + + + +The listener function. |
+
scope |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Object is whose scope to call + the listener. |
+
Removes a binding. Unbinding will set the unbound property to the current + value. The object will not be notified, as the value has not changed.
+Key.
Removes all bindings.
Removes an event listener which was added with listen() by the key returned + by on().
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +number + + + + | + + +
+
+
+
+ <nullable> + + |
+
+
+
+
+ Key. |
+
Parse an expression.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +string + + + + | + + + + + +The expression source (e.g. |
+
An expression instance that can be + evaluated within some scope to provide a value.
+Register a library function to be used in expressions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +The function name (e.g. 'myFunc'). |
+
func |
+
+
+ + + +function + + + + | + + + + + +The function to be called in an
+ expression. This function will be called with a feature as the |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.CoordinateArray + + + + | + + ++ + + + | + + + + +Vertex array (e.g. + [[x0, y0], [x1, y1]]). |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +Array.<ol.CoordinateArray> + + + + | + + ++ + + + | + + + + +Coordinates array. |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.CoordinateArray + + + + | + + ++ + + + | + + + + +Coordinates array. |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +Array.<Array.<ol.CoordinateArray>> + + + + | + + ++ + + + | + + + + +Coordinates + array. |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Coordinates array (e.g. [x, y]). |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
Create a polygon from an array of vertex arrays. Coordinates for the +exterior ring will be forced to clockwise order. Coordinates for any +interior rings will be forced to counter-clockwise order. In cases where +the opposite winding order occurs in the passed vertex arrays, they will +be modified in place.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +Array.<ol.CoordinateArray> + + + + | + + ++ + + + | + + + + +Array of rings. First + is outer, any remaining are inner. |
+
shared |
+
+
+ + + +ol.geom.SharedVertices + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices. |
+
Coordinates array.
+Provides methods for dealing with shared, flattened arrays of vertices.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.geom.SharedVerticesOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Shared vertices options. |
+
Geometry types.
+| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
POINT |
+
+
+ + + +string + + + + | + + + + ++ + point + + | + + ++ |
LINESTRING |
+
+
+ + + +string + + + + | + + + + ++ + linestring + + | + + ++ |
LINEARRING |
+
+
+ + + +string + + + + | + + + + ++ + linearring + + | + + ++ |
POLYGON |
+
+
+ + + +string + + + + | + + + + ++ + polygon + + | + + ++ |
MULTIPOINT |
+
+
+ + + +string + + + + | + + + + ++ + multipoint + + | + + ++ |
MULTILINESTRING |
+
+
+ + + +string + + + + | + + + + ++ + multilinestring + + | + + ++ |
MULTIPOLYGON |
+
+
+ + + +string + + + + | + + + + ++ + multipolygon + + | + + ++ |
GEOMETRYCOLLECTION |
+
+
+ + + +string + + + + | + + + + ++ + geometrycollection + + | + + ++ |
This is an internal class that will be removed from the API.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
buf |
+
+
+ + + +ol.structs.Buffer + + + + | + + ++ + + + | + + + + +Buffer. |
+
ranges |
+
+
+ + + +Object.<string, number>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Ranges. |
+
dim |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Dimension. |
+
This is an internal function that will be removed from the API.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
unpackedLineStrings |
+
+
+ + + +Array.<ol.geom2.LineString> + + + + | + + ++ + + + | + + + + +Unpacked line + strings. |
+
capacity |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Capacity. |
+
dim |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Dimension. |
+
Line string collection.
+This is an internal class that will be removed from the API.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
buf |
+
+
+ + + +ol.structs.Buffer + + + + | + + ++ + + + | + + + + +Buffer. |
+
dim |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Dimension. |
+
This is an internal function that will be removed from the API.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
capacity |
+
+
+ + + +number + + + + | + + ++ + + + | + + + + +Capacity. |
+
dim |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Dimension. |
+
Point collection.
+This is an internal function that will be removed from the API.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
unpackedPoints |
+
+
+ + + +Array.<ol.geom2.Point> + + + + | + + ++ + + + | + + + + +Unpacked points. |
+
capacity |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Capacity. |
+
dim |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Dimension. |
+
Point collection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.geom2.Point + + + + | + + + + + +Point. |
+
Offset.
+ol.inherits is an alias to the goog.inherits function. It is exported +for use in non-compiled application code. See ol.exports.
+ +FIXME: We use a new line to fake the linter. Without the new line the +linter complains with:
+ +"Missing newline between constructor and goog.inherits"
+| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
BOTTOM_LEFT |
+
+
+ + + +string + + + + | + + + + ++ + bottom-left + + | + + ++ |
BOTTOM_RIGHT |
+
+
+ + + +string + + + + | + + + + ++ + bottom-right + + | + + ++ |
TOP_LEFT |
+
+
+ + + +string + + + + | + + + + ++ + top-left + + | + + ++ |
TOP_RIGHT |
+
+
+ + + +string + + + + | + + + + ++ + top-right + + | + + ++ |
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
DEGREES |
+
+
+ + + +string + + + + | + + + + ++ + degrees + + | + + ++ |
FEET |
+
+
+ + + +string + + + + | + + + + ++ + ft + + | + + ++ |
METERS |
+
+
+ + + +string + + + + | + + + + ++ + m + + | + + ++ |
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
CANVAS |
+
+
+ + + +string + + + + | + + + + ++ + canvas + + | + + ++ |
DOM |
+
+
+ + + +string + + + + | + + + + ++ + dom + + | + + ++ |
WEBGL |
+
+
+ + + +string + + + + | + + + + ++ + webgl + + | + + ++ |
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
html |
+
+
+ + + +string + + + + | + + + + + +HTML markup for this attribution. |
+
tileRanges |
+
+
+ + + +Object.<string, Array.<ol.TileRange>> +| + +undefined + + + + | + + + + + +Tile ranges (FOR INTERNAL USE ONLY). |
+
An array representing a coordinate.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Tracking. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Tracking. |
+
trackingOptions |
+
+
+ + + +GeolocationPositionOptions +| + +undefined + + + + | + + + + + +Tracking options. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixel |
+
+
+ + + +ol.Pixel + + + + | + + + + + +Pixel coordinate relative to the map viewport. |
+
layers |
+
+
+ + + +Array.<ol.layer.Layer> +| + +undefined + + + + | + + + + + +Layers to restrict the + query to. All map layers will be queried if not provided. |
+
success |
+
+
+ + + +function + + + + | + + + + + +Callback for
+ successful queries. The passed argument is the resulting feature
+ information for each layer, with array indices being the same as in the
+ passed |
+
error |
+
+
+ + + +function +| + +undefined + + + + | + + + + + +Callback for unsuccessful queries. + Note that queries with no matching features trigger the success callback, + not the error callback. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixel |
+
+
+ + + +ol.Pixel + + + + | + + + + + +Pixel coordinate relative to the map viewport. |
+
layers |
+
+
+ + + +Array.<ol.layer.Layer> +| + +undefined + + + + | + + + + + +Layers to restrict the + query to. All layers will be queried if not provided. |
+
success |
+
+
+ + + +function + + + + | + + + + + +Callback
+ for successful queries. The passed argument is the resulting features for
+ each layer, with array indices being the same as in the passed |
+
error |
+
+
+ + + +function +| + +undefined + + + + | + + + + + +Callback for unsuccessful queries. + Note that queries with no matching features trigger the success callback, + not the error callback. |
+
Object literal with config options for the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
controls |
+
+
+ + + +ol.Collection +| + +Array.<ol.control.Control> +| + +undefined + + + + | + + + + + +Controls initially added to the map. |
+
interactions |
+
+
+ + + +ol.Collection +| + +undefined + + + + | + + + + + +Interactions. |
+
layers |
+
+
+ + + +Array.<ol.layer.Base> +| + +ol.Collection +| + +undefined + + + + | + + + + + +Layers. |
+
overlays |
+
+
+ + + +ol.Collection +| + +Array.<ol.Overlay> +| + +undefined + + + + | + + + + + +Overlays initially added to the map. |
+
renderer |
+
+
+ + + +ol.RendererHint +| + +undefined + + + + | + + + + + +Renderer. |
+
renderers |
+
+
+ + + +Array.<ol.RendererHint> +| + +undefined + + + + | + + + + + +Renderers. |
+
target |
+
+
+ + + +Element +| + +string +| + +undefined + + + + | + + + + + +The container for the map. |
+
view |
+
+
+ + + +ol.IView +| + +undefined + + + + | + + + + + +The map's view. Currently + ol.View2D is available as view. |
+
Object literal with config options for the overlay.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
element |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +The overlay element. |
+
position |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +The overlay position in map + projection. |
+
positioning |
+
+
+ + + +ol.OverlayPositioning +| + +undefined + + + + | + + + + + +Positioning. |
+
Object literal with config options for the Proj4js projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
code |
+
+
+ + + +string + + + + | + + + + + +The SRS identifier code, e.g. 'EPSG:31256'. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The validity extent for the SRS. |
+
global |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the projection is valid for the + whole globe. Default is false. |
+
A projection as ol.Projection, SRS identifier string or undefined.
+Object literal with config options for the projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
code |
+
+
+ + + +string + + + + | + + + + + +The SRS identifier code, e.g. 'EPSG:4326'. |
+
units |
+
+
+ + + +ol.ProjectionUnits + + + + | + + + + + +Units. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The validity extent for the SRS. |
+
axisOrientation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The axis orientation as + specified in Proj4. The default is 'enu'. |
+
global |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the projection is valid for the + whole globe. Default is false. |
+
An array representing a size: [width, height].
+Object literal with config options for the view.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
center |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +The initial center for the view.
+ The coordinate system for the center is specified with the |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution used to
+ determine the resolution constraint. It is used together with |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum zoom level used to determine
+ the resolution constraint. It is used together with |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +The projection. Default is
+ |
+
resolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The initial resolution for the view.
+ The units are |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions to determine the
+ resolution constraint. If set the |
+
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The initial rotation for the view + in radians (positive rotation clockwise). |
+
zoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Zoom level used to calculate the initial
+ resolution for the view. The initial resolution is determined using the
+ |
+
zoomFactor |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The zoom factor used to determine the
+ resolution constraint. It is together with |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.interaction.DragRotateAndZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.interaction.ModifyOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.interaction.SelectOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.layer.GroupOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Layer options. |
+
Collection of layers.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layers |
+
+
+ + + +ol.Collection + + + + | + + + + + +Collection of layers. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.LayerOptions + + + + | + + + + + +Layer options. |
+
Source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.LayerOptions + + + + | + + + + + +Layer options. |
+
Source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.LayerOptions + + + + | + + + + + +Layer options. |
+
Source.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.layer.LayerGroupOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Layer options. |
+
Collection of layers.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layers |
+
+
+ + + +ol.Collection + + + + | + + + + + +Collection of layers. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.TileOptions + + + + | + + + + + +Tile layer options. |
+
Preload.
+Source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
preload |
+
+
+ + + +number + + + + | + + + + + +Preload. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.TileLayerOptions + + + + | + + + + + +Tile layer options. |
+
Preload.
+Source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
preload |
+
+
+ + + +number + + + + | + + + + + +Preload. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.VectorLayerOptions + + + + | + + + + + +Vector layer options. |
+
Source.
+This is an internal class that will be removed from the API.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.LayerOptions + + + + | + + + + + +Options. |
+
Source.
+This is an internal class that will be removed from the API.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.layer.LayerOptions + + + + | + + + + + +Options. |
+
Source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. |
+
layers |
+
+
+ + + +Array.<ol.layer.Base> +| + +ol.Collection +| + +undefined + + + + | + + + + + +Child layers. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. 0-1. Default is 1. |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
source |
+
+
+ + + +ol.source.Source + + + + | + + + + + +Source for this layer. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is true (visible). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. 0-1. Default is 1. |
+
preload |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Preload. |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
source |
+
+
+ + + +ol.source.Source + + + + | + + + + + +Source for this layer. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is true (visible). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
transformFeatureInfo |
+
+
+ + + +function + + + + | + + + + + +Function to render an array of + features into feature info markup. If not provided, a comma separated + list of the unique ids of the resulting features will be returned. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. 0-1. Default is 1. |
+
source |
+
+
+ + + +ol.source.Source + + + + | + + + + + +Source for this layer. |
+
style |
+
+
+ + + +ol.style.Style +| + +undefined + + + + | + + + + + +Style. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is true (visible). |
+
Read and write GPX version 1.1
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.parser.GPXOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Optional configuration object. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
data |
+
+
+ + + +string +| + +Document +| + +Element +| + +Object + + + + | + + + + + +Data to read. |
+
An object representing the document.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
obj |
+
+
+ + + +ol.parser.GPXWriteOptions + + + + | + + + + + +Object structure to write out + as GPX. |
+
An string representing the GPX document.
+Read and write GeoJSON
+Parse a GeoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +GeoJSON string. |
+
Parsed geometry or array + of geometries.
+Write out a geometry, geometry collection, feature or an array of features + as a GeoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
obj |
+
+
+ + + +ol.geom.Geometry +| + +ol.geom.GeometryCollection +| + +ol.Feature +| + +Array.<ol.Feature> + + + + | + + + + + +The object to encode. |
+
GeoJSON for the geometry.
+Parse a GeoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +GeoJSON string. |
+
Parsed geometry or array + of geometries.
+Write out a geometry, geometry collection, feature or an array of features + as a GeoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
obj |
+
+
+ + + +ol.geom.Geometry +| + +ol.geom.GeometryCollection +| + +ol.Feature +| + +Array.<ol.Feature> + + + + | + + + + + +The object to encode. |
+
GeoJSON for the geometry.
+Read and write KML +version 2.2
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.parser.KMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Optional configuration object. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
data |
+
+
+ + + +string +| + +Document +| + +Element +| + +Object + + + + | + + ++ + + + | + + + + +Data to read. |
+
callback |
+
+
+ + + +function + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Optional + callback to call when reading is done. If provided, this method will + return undefined. |
+
An object representing the
+ document if opt_callback was not provided.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
obj |
+
+
+ + + +Object + + + + | + + + + + +Object structure to write out as XML. |
+
An string representing the XML document.
+Read TopoJSON
+Parse a TopoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +TopoJSON string. |
+
Array of features.
+Parse a TopoJSON string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +TopoJSON string. |
+
Array of features.
+Parse a WKT string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +WKT string. |
+
Parsed geometry.
+Write out a geometry as a WKT string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
geom |
+
+
+ + + +ol.geom.Geometry + + + + | + + + + + +The geometry to encode. |
+
WKT for the geometry.
+Parse a WKT string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
str |
+
+
+ + + +string + + + + | + + + + + +WKT string. |
+
Parsed geometry.
+Write out a geometry as a WKT string.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
geom |
+
+
+ + + +ol.geom.Geometry + + + + | + + + + + +The geometry to encode. |
+
WKT for the geometry.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
curve |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Write gml:Curve instead of + gml:LineString elements. This also affects the elements in multi-part + geometries. Default is `false´. This only applies to GML version 3. |
+
extractAttributes |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Should we extract attributes + from the GML? Default is `true´. |
+
featureNS |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The feature namespace. If not set it + will be automatically configured from the GML. |
+
featureType |
+
+
+ + + +Array.<string> +| + +string +| + +undefined + + + + | + + + + + +The local + (without prefix) feature typeName(s). |
+
geometryName |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Name of geometry element.
+ Defaults to `geometry´. If null, it will be set on |
+
multiCurve |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Write gml:MultiCurve instead of + gml:MultiLineString. Since the latter is deprecated in GML 3, the + default is `true´. This only applies to GML version 3. |
+
multiSurface |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Write gml:multiSurface instead + of gml:MultiPolygon. Since the latter is deprecated in GML 3, the + default is `true´. This only applies to GML version 3. |
+
schemaLocation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Optional schemaLocation to use + when writing out the GML, this will override the default provided. |
+
surface |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Write gml:Surface instead of + gml:Polygon elements. This also affects the elements in multi-part + geometries. Default is `false´. This only applies to GML version 3. |
+
readOptions |
+
+
+ + + +ol.parser.GMLReadOptions +| + +undefined + + + + | + + + + + +readOptions to + use for this instance. |
+
writeOptions |
+
+
+ + + +ol.parser.GMLWriteOptions +| + +undefined + + + + | + + + + + +writeOptions + to use for this instance. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
axisOrientation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The axis orientation. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
srsName |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +The srsName to use when writing. |
+
axisOrientation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The axis orientation. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
creator |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The creator attribute to be added to + the written GPX files. Defaults to `OpenLayers´. |
+
defaultDesc |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Default description for the + waypoints/tracks in the case where the feature has no 'description' + attribute. Default is 'No description available'. |
+
extractAttributes |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Should we extract attributes + from the GPX? Default is `true´. |
+
extractWaypoints |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Extract waypoints from GPX. + Default is `true´. |
+
extractTracks |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Extract tracks from GPX. + Default is `true´. |
+
extractRoutes |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Extract routes from GPX. + Default is `true´. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> +| + +ol.Feature + + + + | + + + + + +The features to write + out. |
+
metadata |
+
+
+ + + +Object +| + +undefined + + + + | + + + + + +Metadata key/value pair with keys: + name, desc and author. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
dimension |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Create geometries with |
+
extractAttributes |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Should we extract attributes + from the KML? Default is `true´. |
+
extractStyles |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Should we extract styles from the
+ KML? Default is |
+
maxDepth |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum depth to follow network links. + Default is 0, which means we don't follow network links at all. |
+
trackAttributes |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +Track attributes to + parse. |
+
Read and write GML +version 2.1.2
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.parser.GMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Optional configuration object. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
obj |
+
+
+ + + +ol.parser.ReadFeaturesResult + + + + | + + ++ + + + | + + + + +Object structure to write out as +GML. |
+
options |
+
+
+ + + +ol.parser.GMLWriteOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Write options. |
+
A string representing the GML document.
+Read and write GML +version 3.1.1
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.parser.GMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Optional configuration object. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
obj |
+
+
+ + + +ol.parser.ReadFeaturesResult + + + + | + + ++ + + + | + + + + +Object structure to write out as + XML. |
+
options |
+
+
+ + + +ol.parser.GMLWriteOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Write options. |
+
An string representing the XML document.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options which will be set on this object. |
+
Read WMTS capabilities
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Options which will be set on this object. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.Proj4jsProjectionOptions + + + + | + + + + + +Proj4js projection options. |
+
Proj4js projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projectionLike |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Either a code string which is a + combination of authority and identifier such as "EPSG:4326", or an + existing projection object, or undefined. |
+
Projection.
+Given the projection-like objects this method searches for a transformation +function to convert a coordinates array from the source projection to the +destination projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Source. |
+
destination |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Destination. |
+
Transform.
+Searches a function that can be used to convert coordinates from the source +projection to the destination projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
sourceProjection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Source projection. |
+
destinationProjection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Destination projection. |
+
Transform.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Point. |
+
source |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Source. |
+
destination |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Destination. |
+
Point.
+Transforms the given point to the destination projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Point. |
+
sourceProjection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Source projection. |
+
destinationProjection |
+
+
+ + + +ol.Projection + + + + | + + + + + +Destination projection. |
+
Point.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.BingMapsOptions + + + + | + + + + + +Bing Maps options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.DebugTileSourceOptions + + + + | + + + + + +Debug tile options. |
+
Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.ImageStaticOptions + + + + | + + + + + +Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.ImageWMSOptions + + + + | + + + + + +Options. |
+
Get the user-provided params, i.e. those passed to the constructor through +the "params" option, and possibly updated using the updateParams method.
+Params.
+Update the user-provided params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
params |
+
+
+ + + +Object + + + + | + + + + + +Params. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.source.OSMOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Open Street Map options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.SingleImageWMSOptions + + + + | + + + + + +Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.StamenOptions + + + + | + + + + + +Stamen options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.StaticImageOptions + + + + | + + + + + +Static image options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileOptions + + + + | + + + + + +Tile source options. |
+
Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileDebugOptions + + + + | + + + + + +Debug tile options. |
+
Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileJSONOptions + + + + | + + + + + +TileJSON options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileSourceOptions + + + + | + + + + + +Tile source options. |
+
Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileWMSOptions + + + + | + + + + + +Tile WMS options. |
+
Get the user-provided params, i.e. those passed to the constructor through +the "params" option, and possibly updated using the updateParams method.
+Params.
+Update the user-provided params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
params |
+
+
+ + + +Object + + + + | + + + + + +Params. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TiledWMSOptions + + + + | + + + + + +Tiled WMS options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.VectorOptions + + + + | + + + + + +Vector source options. |
+
This is an internal class that will be removed from the API.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.Vector2Options + + + + | + + + + + +Options. |
+
This is an internal class that will be removed from the API.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.VectorSource2Options + + + + | + + + + + +Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.WMTSOptions + + + + | + + + + + +WMTS options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
wmtsCap |
+
+
+ + + +Object + + + + | + + + + + +An object representing the capabilities document. |
+
layer |
+
+
+ + + +string + + + + | + + + + + +The layer identifier. |
+
WMTS source options object.
+Get the dimensions, i.e. those passed to the constructor through the +"dimensions" option, and possibly updated using the updateDimensions +method.
+Dimensions.
+Update the dimensions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
dimensions |
+
+
+ + + +Object + + + + | + + + + + +Dimensions. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.XYZOptions + + + + | + + + + + +XYZ options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
Method to use to get WMS feature info.
+| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
IFRAME |
+
+
+ + + +string + + + + | + + + + ++ + iframe + + | + + +Load the info in an IFRAME. Only works with 'text/html and 'text/plain' as
+ |
+
XHR_GET |
+
+
+ + + +string + + + + | + + + + ++ + xhr_get + + | + + +Use an asynchronous GET request. Requires CORS headers or a server at the +same origin as the application script. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
culture |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Culture. |
+
key |
+
+
+ + + +string + + + + | + + + + + +Bing Maps API key. Get yours at + http://bingmapsportal.com/. |
+
style |
+
+
+ + + +string + + + + | + + + + + +Style. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
imageExtent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent of the image. |
+
imageSize |
+
+
+ + + +ol.Size +| + +undefined + + + + | + + + + + +Size of the image. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Url. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
getFeatureInfoOptions |
+
+
+ + + +ol.source.WMSGetFeatureInfoOptions +| + +undefined + + + + | + + + + + +Options for GetFeatureInfo. |
+
params |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +WMS request parameters. At least a
+ |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
ratio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Ratio. 1 means image requests are the size + of the map viewport, 2 means twice the size of the map viewport, and so + on. |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions. If specified, + requests will be made for these resolutions only. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +WMS service url. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attribution |
+
+
+ + + +ol.Attribution +| + +undefined + + + + | + + + + + +Attribution. |
+
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Max zoom. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +string + + + + | + + + + + +Layer. |
+
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum zoom. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
opaque |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the layer is opaque. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Url. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.TileGrid +| + +undefined + + + + | + + + + + +Tile grid. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOriin setting for image + requests. |
+
url |
+
+
+ + + +string + + + + | + + + + + +Url. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
params |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +WMS request parameters. At least a
+ |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
getFeatureInfoOptions |
+
+
+ + + +ol.source.WMSGetFeatureInfoOptions +| + +undefined + + + + | + + + + + +Options for GetFeatureInfo. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.TileGrid +| + +undefined + + + + | + + + + + +Tile grid. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +WMS service url. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +WMS service urls. Use this instead
+ of |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
lineStringCollections |
+
+
+ + + +Array.<ol.geom2.LineStringCollection> +| + +undefined + + + + | + + + + + +Line string collections. |
+
pointCollections |
+
+
+ + + +Array.<ol.geom2.PointCollection> +| + +undefined + + + + | + + + + + +Point collections. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
data |
+
+
+ + + +Object +| + +string +| + +undefined + + + + | + + + + + +Data to parse. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
parser |
+
+
+ + + +ol.parser.Parser + + + + | + + + + + +Parser instance to parse data
+ provided as |
+
projection |
+
+
+ + + +ol.ProjectionLike +| + +undefined + + + + | + + + + + +Projection. Usually the + projection is provided by the parser, so this only needs to be set if + the parser does not know the SRS (e.g. in some GML flavors), or if the + projection determined by the parser needs to be overridden. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Server url providing the vector data. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
method |
+
+
+ + + +ol.source.WMSGetFeatureInfoMethod + + + + | + + + + + +Method for requesting
+ GetFeatureInfo. Default is |
+
params |
+
+
+ + + +Object + + + + | + + + + + +Params for the GetFeatureInfo request. Default is
+ |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +string +| + +null +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.WMTS + + + + | + + + + + +Tile grid. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
requestEncoding |
+
+
+ + + +ol.source.WMTSRequestEncoding +| + +undefined + + + + | + + + + + +Request + encoding. |
+
layer |
+
+
+ + + +string + + + + | + + + + + +Layer. |
+
style |
+
+
+ + + +string + + + + | + + + + + +Style. |
+
version |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +WMTS version. Default to '1.0.0'. |
+
format |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Format. |
+
matrixSet |
+
+
+ + + +string + + + + | + + + + + +Matrix set. |
+
dimensions |
+
+
+ + + +Object +| + +undefined + + + + | + + + + + +Dimensions. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Url. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +Urls. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +Cross origin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.ProjectionLike + + + + | + + + + + +Projection. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Optional max zoom level. The default is + 18. |
+
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Unsupported (TODO: remove this). |
+
tileUrlFunction |
+
+
+ + + +ol.TileUrlFunctionType +| + +undefined + + + + | + + + + + +Optional + function to get tile URL given a tile coordinate and the projection. + Required if url or urls are not provided. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL template. Must include '{x}', '{y}', + and '{z}' placeholders. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +An array of URL templates. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
arr |
+
+
+ + + +Array.<number>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Array. |
+
used |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Used. |
+
usage |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Usage. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.style.FillOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Polygon options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.IconOptions + + + + | + + + + + +Icon options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.RuleOptions + + + + | + + + + + +Rule options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.ShapeOptions + + + + | + + + + + +Shape options. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +ol.style.StrokeOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ (Optional) Stroke options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.StyleOptions + + + + | + + + + + +Style options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.TextOptions + + + + | + + + + + +Text options. |
+
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
CIRCLE |
+
+
+ + + +string + + + + | + + + + ++ + circle + + | + + ++ |
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
color |
+
+
+ + + +string +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Fill color as hex color + code. |
+
opacity |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Opacity (0-1). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string +| + +ol.expr.Expression + + + + | + + + + + +Icon image url. |
+
width |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Width of the icon + in pixels. Default is the width of the icon image. |
+
height |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Height of the + icon in pixels. Default is the height of the icon image. |
+
opacity |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Icon opacity + (0-1). |
+
rotation |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Rotation in + radians (positive rotation clockwise). |
+
xOffset |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Pixel offset from the + point to the center of the icon (positive values shift image left). |
+
yOffset |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Pixel offset from the + point to the center of the icon (positive values shift image down). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
filter |
+
+
+ + + +ol.expr.Expression +| + +string +| + +undefined + + + + | + + + + + +Filter. |
+
symbolizers |
+
+
+ + + +Array.<ol.style.Symbolizer> +| + +undefined + + + + | + + + + + +Symbolizers. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
type |
+
+
+ + + +ol.style.ShapeType +| + +undefined + + + + | + + + + + +Type. |
+
size |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Size in pixels. |
+
fill |
+
+
+ + + +ol.style.Fill +| + +undefined + + + + | + + + + + +Fill symbolizer for shape. |
+
stroke |
+
+
+ + + +ol.style.Stroke +| + +undefined + + + + | + + + + + +Stroke symbolizer for shape. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
color |
+
+
+ + + +string +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Stroke color as hex + color code. |
+
opacity |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Stroke opacity (0-1). |
+
width |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Stroke width in pixels. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rules |
+
+
+ + + +Array.<ol.style.Rule> +| + +undefined + + + + | + + + + + +Rules. |
+
symbolizers |
+
+
+ + + +Array.<ol.style.Symbolizer> +| + +undefined + + + + | + + + + + +Symbolizers + (that apply if no rules are provided or where none of the provided rules + apply). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
color |
+
+
+ + + +string +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Color. |
+
fontFamily |
+
+
+ + + +string +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Font family. |
+
fontSize |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Font size in pixels. |
+
text |
+
+
+ + + +string +| + +ol.expr.Expression + + + + | + + + + + +Text for the label. |
+
opacity |
+
+
+ + + +number +| + +ol.expr.Expression +| + +undefined + + + + | + + + + + +Opacity (0-1). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.tilegrid.TileGridOptions + + + + | + + + + + +Tile grid options. |
+
Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.tilegrid.WMTSOptions + + + + | + + + + + +WMTS options. |
+
MatrixIds.
+Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.tilegrid.XYZOptions + + + + | + + + + + +XYZ options. |
+
Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum zoom. |
+
origin |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +Origin. |
+
origins |
+
+
+ + + +Array.<ol.Coordinate> +| + +undefined + + + + | + + + + + +Origins. |
+
resolutions |
+
+
+ + + +!Array.<number> + + + + | + + + + + +Resolutions. |
+
tileSize |
+
+
+ + + +ol.Size +| + +undefined + + + + | + + + + + +Tile size. |
+
tileSizes |
+
+
+ + + +Array.<ol.Size> +| + +undefined + + + + | + + + + + +Tile sizes. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
origin |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +Origin. |
+
origins |
+
+
+ + + +Array.<ol.Coordinate> +| + +undefined + + + + | + + + + + +Origins. |
+
resolutions |
+
+
+ + + +!Array.<number> + + + + | + + + + + +Resolutions. |
+
matrixIds |
+
+
+ + + +!Array.<string> + + + + | + + + + + +matrix IDs. |
+
tileSize |
+
+
+ + + +ol.Size +| + +undefined + + + + | + + + + + +Tile size. |
+
tileSizes |
+
+
+ + + +Array.<ol.Size> +| + +undefined + + + + | + + + + + +Tile sizes. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxZoom |
+
+
+ + + +number + + + + | + + + + + +Maximum zoom. |
+
goog.math.Coordinate // Simple 2D point
+|
++- TileCoord
+
+goog.math.Box
+|
++- Extent // The extent of a single object in two dimensions, projection not stored
+|
++- TileBounds // A range of tiles in two dimensions, integer coordinates, z not stored
+
+
+Projection
+
+
+goog.events.EventTarget
+|
++- MVCObject
+| |
+| +- Camera
+| |
+| +- Control
+| | |
+| | +- ?
+| |
+| +- Layer
+| | |
+| | +- TileLayer
+| | | |
+| | | +- TMSTileLayer
+| | | |
+| | | +- WMTSTileLayer
+| | | |
+| | | +- XYZTileLayer / OSMTileLayer
+| | |
+| | +- VectorLayer
+| | |
+| | +- ImageLayer
+| |
+| +- LayerRenderer
+| |
+| +- LayerRendererOptions
+| |
+| +- Map
+| |
+| +- MapRenderer
+| | |
+| | +- HTMLMapRenderer
+| | |
+| | +- WebGLMapRenderer
+| |
+| +- MVCArray
+| | |
+| | +- ControlArray
+| | |
+| | +- LayerViewArray
+|
+| +- TileQueue
+|
++- Tile
+goog.events.EventTarget
+|
++- MVCObject
+ |
+ +- LayerRenderer
+ |
+ +- SingleTileLayerRenderer
+ | |
+ | +- HTMLSingleTileLayerRenderer
+ | |
+ | +- WebGLSingleTileLayerRenderer
+ |
+ +- TileLayerRenderer
+ | |
+ | +- HTMLTileLayerRenderer
+ | |
+ | +- WebGLTileLayerRenderer
+ |
+ +- VectorLayerRenderer
+ | |
+ | +- HTMLVectorLayerRenderer
+ | | |
+ | | +- SVGHTMLVectorLayerRenderer
+ | | |
+ | | +- Canvas2DHTMLVectorLayerRenderer
+ | | |
+ | | +- VMLHTMLVectorLayerRenderer
+ | |
+ | +- WebGLVectorLayerRenderer
+Notation:
+ +property type property with type, trailing ? indicates unsure, getters and setters are assumed to exist.f(args) -> type function taking args returning type.f(args) -> type = something f is a trivial wrapper around something.fires 'x' fires events of type 'x'.Principles:
+ +MVCObject.MVCArrays or a child class thereof.Array., infinitely scalable resources (e.g. vectore layers) have resolutions == null.MVCObject
+ as Google Maps MVCObject
+ freeze()
+ unfreeze()
+
+TileCoord
+ clone() -> TileCoord
+ getHash() -> number
+
+TileBounds
+ forEachTileCoord(z, function(tileCoord))
+
+Tile
+ tileCoord TileCoord
+ url string
+ state UNLOADED | LOADING | LOADED
+ fires 'loaded' // when loaded
+ fires 'aborted' // when loading is aborted
+
+Camera
+ position goog.math.Coordinate
+ resolution number
+ rotation number
+
+Layer
+ projections Array.
+ extent Extent
+ getResolutions() -> Array.|null
+ fires 'change' // when data changes
+
+LayerArray
+ getResolutions() -> Array.|null
+ getMaxResolution() = this.getResolutions()[0] | null
+
+LayerRendererOptions
+ layer Layer
+ visible boolean
+ opacity number
+ brightness number
+ color number
+ hue number
+ saturation number
+
+Map
+ projection Projection
+ renderer Renderer
+ layers LayerArray
+ addLayer(layer) = layers.push(layer)
+ getExtent() -> Extent
+ getMaxResolution() = layers.getMaxResolution()
+
+TileGrid
+ resolutions Array.
+ extent ol.Extent
+ xEast boolean
+ ySouth boolean
+ origin(s) Coord|Array.
+ tileSize goog.math.Size
+ forEachTileCoordChild(tileCoord, function(z, TileBounds))
+ forEachTileCoordParent(tileCoord, function(z, TileBounds))
+ getExtentTileBounds(z, extent) -> TileBounds
+ getTileCoord(coordinate) -> TileCoord
+ getTileCoordCenter(tileCoord) -> goog.math.Coordinate
+ getTileCoordExtent(tileCoord) -> ol.Extent
+ getTileCoordResolution(tileCoord) -> number
+ getZForResolution(resolution) -> number
+
+TileLayer
+ tileGrid TileGrid
+ tileUrl function(tileCoord) -> string
+ getTileCoordUrl(tileCoord) -> string = this.tileUrl(tileCoord)
+
+TileQueue
+ camera Camera // or maybe MVCArray. ?
+ getTileCoordPriority(tileCoord) -> number // private
+ enqueueTile(Tile)
+
+VectorLayer
+ forEachFeature(resolution, extent, projection, function(Feature))
+
+Renderer
+ target HTMLDivElement
+ map Map
+ camera Camera
+ getCapabilities() -> Array. // maybe ?
+ Questions:
+ +Two concepts: tile coordinate system range and and available data extent. +TileGrid extent is range (or validity extent) of the tile coordinate system. +TileLayer extent is the available data extent. A particular TileGrid may range +from 0,0 to 10,10. My cache may conform to that grid but I may only have tiles +ranging from 2,2 to 8,8. When you need to wrap multiple worlds, you pay +attention to the TileGrid extent. When you need to decide whether or not to +bother requesting a tile, you pay attention to the TileLayer extent.
+ +Todo: if tile layer extent stored in TileLayer rather than TileGrid then extent +will occasionally need to be passed to TileGrid functions for cropping.
+ +Map
+ +Layer
+ +LayerRendererOptions
+ +Renderer
+ +Control
+ +MVC
+ ++ * range(5) is the same as range(0, 5, 1) and produces [0, 1, 2, 3, 4] + * range(2, 5) is the same as range(2, 5, 1) and produces [2, 3, 4] + * range(-2, -5, -1) produces [-2, -3, -4] + * range(-2, -5, 1) produces [], since stepping by 1 wouldn't ever reach -5. + *+ * + * @param {number} startOrEnd The starting value of the range if an end argument + * is provided. Otherwise, the start value is 0, and this is the end value. + * @param {number=} opt_end The optional end value of the range. + * @param {number=} opt_step The step size between range values. Defaults to 1 + * if opt_step is undefined or 0. + * @return {!Array.
CLOSURE_NO_DEPS is set to true. This allows projects to
* include their own deps file(s) from different locations.
*
+ *
+ * @provideGoog
*/
@@ -30,23 +32,100 @@ var COMPILED = false;
/**
- * Base namespace for the Closure library. Checks to see goog is
- * already defined in the current scope before assigning to prevent
- * clobbering if base.js is loaded more than once.
+ * Base namespace for the Closure library. Checks to see goog is already
+ * defined in the current scope before assigning to prevent clobbering if
+ * base.js is loaded more than once.
*
* @const
*/
-var goog = goog || {}; // Identifies this file as the Closure base.
+var goog = goog || {};
/**
- * @define {boolean}
+ * Reference to the global context. In most cases this will be 'window'.
*/
-goog.NODE_JS = false;
+goog.global = this;
-// eval() is used so that "global" does not need to be an extern.
-goog.global = goog.NODE_JS ? eval('global') : this;
+/**
+ * A hook for overriding the define values in uncompiled mode.
+ *
+ * In uncompiled mode, {@code CLOSURE_DEFINES} may be defined before loading
+ * base.js. If a key is defined in {@code CLOSURE_DEFINES}, {@code goog.define}
+ * will use the value instead of the default value. This allows flags to be
+ * overwritten without compilation (this is normally accomplished with the
+ * compiler's "define" flag).
+ *
+ * Example:
+ *
+ * var CLOSURE_DEFINES = {'goog.DEBUG', false};
+ *
+ *
+ * @type {Object.bar"), // the FormatBlock command actually formats the "bar" instead of the "foo". @@ -660,7 +662,7 @@ goog.editor.plugins.EnterHandler.deleteW3cRange_ = function(range) { // Don't break Opera's native break-out-of-lists behavior. html = '
+ * var source = new goog.events.EventTarget();
+ * function handleEvent(e) {
+ * alert('Type: ' + e.type + '; Target: ' + e.target);
+ * }
+ * source.listen('foo', handleEvent);
+ * // Or: goog.events.listen(source, 'foo', handleEvent);
+ * ...
+ * source.dispatchEvent('foo'); // will call handleEvent
+ * ...
+ * source.unlisten('foo', handleEvent);
+ * // Or: goog.events.unlisten(source, 'foo', handleEvent);
+ *
+ *
+ * TODO(user): Consider writing a parallel class to this that
+ * does not implement goog.Disposable.
+ *
+ * @constructor
+ * @extends {goog.Disposable}
+ * @implements {goog.events.Listenable}
+ */
+goog.events.EventTarget = function() {
+ goog.Disposable.call(this);
+
+ /**
+ * Maps of event type to an array of listeners.
+ * @private {!goog.events.ListenerMap}
+ */
+ this.eventTargetListeners_ = new goog.events.ListenerMap(this);
+
+ /**
+ * The object to use for event.target. Useful when mixing in an
+ * EventTarget to another object.
+ * @private {!Object}
+ */
+ this.actualEventTarget_ = this;
+};
+goog.inherits(goog.events.EventTarget, goog.Disposable);
+goog.events.Listenable.addImplementation(goog.events.EventTarget);
+
+
+/**
+ * An artificial cap on the number of ancestors you can have. This is mainly
+ * for loop detection.
+ * @const {number}
+ * @private
+ */
+goog.events.EventTarget.MAX_ANCESTORS_ = 1000;
+
+
+/**
+ * Parent event target, used during event bubbling.
+ *
+ * TODO(user): Change this to goog.events.Listenable. This
+ * currently breaks people who expect getParentEventTarget to return
+ * goog.events.EventTarget.
+ *
+ * @type {goog.events.EventTarget}
+ * @private
+ */
+goog.events.EventTarget.prototype.parentEventTarget_ = null;
+
+
+/**
+ * Returns the parent of this event target to use for bubbling.
+ *
+ * @return {goog.events.EventTarget} The parent EventTarget or null if
+ * there is no parent.
+ * @override
+ */
+goog.events.EventTarget.prototype.getParentEventTarget = function() {
+ return this.parentEventTarget_;
+};
+
+
+/**
+ * Sets the parent of this event target to use for capture/bubble
+ * mechanism.
+ * @param {goog.events.EventTarget} parent Parent listenable (null if none).
+ */
+goog.events.EventTarget.prototype.setParentEventTarget = function(parent) {
+ this.parentEventTarget_ = parent;
+};
+
+
+/**
+ * Adds an event listener to the event target. The same handler can only be
+ * added once per the type. Even if you add the same handler multiple times
+ * using the same type then it will only be called once when the event is
+ * dispatched.
+ *
+ * Supported for legacy but use goog.events.listen(src, type, handler) instead.
+ *
+ * TODO(user): Deprecate this.
+ *
+ * @param {string} type The type of the event to listen for.
+ * @param {Function|Object} handler The function to handle the event. The
+ * handler can also be an object that implements the handleEvent method
+ * which takes the event object as argument.
+ * @param {boolean=} opt_capture In DOM-compliant browsers, this determines
+ * whether the listener is fired during the capture or bubble phase
+ * of the event.
+ * @param {Object=} opt_handlerScope Object in whose scope to call
+ * the listener.
+ */
+goog.events.EventTarget.prototype.addEventListener = function(
+ type, handler, opt_capture, opt_handlerScope) {
+ goog.events.listen(this, type, handler, opt_capture, opt_handlerScope);
+};
+
+
+/**
+ * Removes an event listener from the event target. The handler must be the
+ * same object as the one added. If the handler has not been added then
+ * nothing is done.
+ *
+ * TODO(user): Deprecate this.
+ *
+ * @param {string} type The type of the event to listen for.
+ * @param {Function|Object} handler The function to handle the event. The
+ * handler can also be an object that implements the handleEvent method
+ * which takes the event object as argument.
+ * @param {boolean=} opt_capture In DOM-compliant browsers, this determines
+ * whether the listener is fired during the capture or bubble phase
+ * of the event.
+ * @param {Object=} opt_handlerScope Object in whose scope to call
+ * the listener.
+ */
+goog.events.EventTarget.prototype.removeEventListener = function(
+ type, handler, opt_capture, opt_handlerScope) {
+ goog.events.unlisten(this, type, handler, opt_capture, opt_handlerScope);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.dispatchEvent = function(e) {
+ this.assertInitialized_();
+
+ var ancestorsTree, ancestor = this.getParentEventTarget();
+ if (ancestor) {
+ ancestorsTree = [];
+ var ancestorCount = 1;
+ for (; ancestor; ancestor = ancestor.getParentEventTarget()) {
+ ancestorsTree.push(ancestor);
+ goog.asserts.assert(
+ (++ancestorCount < goog.events.EventTarget.MAX_ANCESTORS_),
+ 'infinite loop');
+ }
+ }
+
+ return goog.events.EventTarget.dispatchEventInternal_(
+ this.actualEventTarget_, e, ancestorsTree);
+};
+
+
+/**
+ * Removes listeners from this object. Classes that extend EventTarget may
+ * need to override this method in order to remove references to DOM Elements
+ * and additional listeners.
+ * @override
+ */
+goog.events.EventTarget.prototype.disposeInternal = function() {
+ goog.events.EventTarget.superClass_.disposeInternal.call(this);
+
+ this.removeAllListeners();
+ this.parentEventTarget_ = null;
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.listen = function(
+ type, listener, opt_useCapture, opt_listenerScope) {
+ this.assertInitialized_();
+ return this.eventTargetListeners_.add(
+ type, listener, false /* callOnce */, opt_useCapture, opt_listenerScope);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.listenOnce = function(
+ type, listener, opt_useCapture, opt_listenerScope) {
+ return this.eventTargetListeners_.add(
+ type, listener, true /* callOnce */, opt_useCapture, opt_listenerScope);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.unlisten = function(
+ type, listener, opt_useCapture, opt_listenerScope) {
+ return this.eventTargetListeners_.remove(
+ type, listener, opt_useCapture, opt_listenerScope);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.unlistenByKey = function(key) {
+ return this.eventTargetListeners_.removeByKey(key);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.removeAllListeners = function(opt_type) {
+ // TODO(user): Previously, removeAllListeners can be called on
+ // uninitialized EventTarget, so we preserve that behavior. We
+ // should remove this when usages that rely on that fact are purged.
+ if (!this.eventTargetListeners_) {
+ return 0;
+ }
+ return this.eventTargetListeners_.removeAll(opt_type);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.fireListeners = function(
+ type, capture, eventObject) {
+ // TODO(user): Original code avoids array creation when there
+ // is no listener, so we do the same. If this optimization turns
+ // out to be not required, we can replace this with
+ // getListeners(type, capture) instead, which is simpler.
+ var listenerArray = this.eventTargetListeners_.listeners[type];
+ if (!listenerArray) {
+ return true;
+ }
+ listenerArray = goog.array.clone(listenerArray);
+
+ var rv = true;
+ for (var i = 0; i < listenerArray.length; ++i) {
+ var listener = listenerArray[i];
+ // We might not have a listener if the listener was removed.
+ if (listener && !listener.removed && listener.capture == capture) {
+ var listenerFn = listener.listener;
+ var listenerHandler = listener.handler || listener.src;
+
+ if (listener.callOnce) {
+ this.unlistenByKey(listener);
+ }
+ rv = listenerFn.call(listenerHandler, eventObject) !== false && rv;
+ }
+ }
+
+ return rv && eventObject.returnValue_ != false;
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.getListeners = function(type, capture) {
+ return this.eventTargetListeners_.getListeners(type, capture);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.getListener = function(
+ type, listener, capture, opt_listenerScope) {
+ return this.eventTargetListeners_.getListener(
+ type, listener, capture, opt_listenerScope);
+};
+
+
+/** @override */
+goog.events.EventTarget.prototype.hasListener = function(
+ opt_type, opt_capture) {
+ return this.eventTargetListeners_.hasListener(opt_type, opt_capture);
+};
+
+
+/**
+ * Sets the target to be used for {@code event.target} when firing
+ * event. Mainly used for testing. For example, see
+ * {@code goog.testing.events.mixinListenable}.
+ * @param {!Object} target The target.
+ */
+goog.events.EventTarget.prototype.setTargetForTesting = function(target) {
+ this.actualEventTarget_ = target;
+};
+
+
+/**
+ * Asserts that the event target instance is initialized properly.
+ * @private
+ */
+goog.events.EventTarget.prototype.assertInitialized_ = function() {
+ goog.asserts.assert(
+ this.eventTargetListeners_,
+ 'Event target is not initialized. Did you call the superclass ' +
+ '(goog.events.EventTarget) constructor?');
+};
+
+
+/**
+ * Dispatches the given event on the ancestorsTree.
+ *
+ * TODO(user): Look for a way to reuse this logic in
+ * goog.events, if possible.
+ *
+ * @param {!Object} target The target to dispatch on.
+ * @param {goog.events.Event|Object|string} e The event object.
+ * @param {Array.WebChannel. Multiple WebChannels
+ * may be multiplexed over the same WebChannelTransport, which represents
+ * the underlying physical connectivity over standard wire protocols
+ * such as HTTP and SPDY.
+ *
+ * A WebChannels in turn represents a logical communication channel between
+ * the client and server end point. A WebChannel remains open for
+ * as long as the client or server end-point allows.
+ *
+ * Messages may be delivered in-order or out-of-order, reliably or unreliably
+ * over the same WebChannel. Message delivery guarantees of a WebChannel is
+ * to be specified by the application code; and the choice of the
+ * underlying wire protocols is completely transparent to the API users.
+ *
+ * Client-to-client messaging via WebRTC based transport may also be support
+ * via the same WebChannel API in future.
+ *
+ */
+
+goog.provide('goog.net.WebChannel');
+
+goog.require('goog.events');
+goog.require('goog.events.Event');
+
+
+
+/**
+ * A WebChannel represents a logical bi-directional channel over which the
+ * client communicates with a remote server that holds the other endpoint
+ * of the channel. A WebChannel is always created in the context of a shared
+ * {@link WebChannelTransport} instance. It is up to the underlying client-side
+ * and server-side implementations to decide how or when multiplexing is
+ * to be enabled.
+ *
+ * @interface
+ * @extends {EventTarget}
+ */
+goog.net.WebChannel = function() {};
+
+
+/**
+ * Configuration spec of a WebChannel (TODO(user): to complete):
+ * 1) delivery: ordered, reliable, timeout
+ * 2) HTTP: special headers, URI prefix, cross domains
+ * 3) debugging: stats, logging
+ * 4) pattern: full-duplex, server-client or client-server messaging
+ * 5) QoS: priority, throttling,
+ * 6) buffer management: batch size, delivery interval
+ *
+ * WebChannels are configured in the context of the containing
+ * {@link WebChannelTransport}. The configuration parameters are specified
+ * when a new instance of WebChannel is created via {@link WebChannelTransport}.
+ *
+ * @typedef {{
+ * ordered: (boolean|undefined),
+ * reliable: (boolean|undefined),
+ * timeoutMs: (number|undefined),
+ * priority: (number|undefined)
+ * }}
+ */
+goog.net.WebChannel.Options;
+
+
+/**
+ * Types that are allowed as message data.
+ *
+ * @typedef {(ArrayBuffer|Blob|Object.