OpenLayers 3
+ OpenLayers 3
+ 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.proj.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 retrieving data and displaying it.
+See CONTRIBUTING.md for instructions +on building and testing OpenLayers. The file does also describe how to commit your changes to OpenLayers.
OpenLayers 3
+ 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 |
+
+
+ + + +olx.AttributionOptions + + + + | + + + + + +Attribution options. |
+
OpenLayers 3
+ The ratio between physical pixels and device-independent pixels
+(dips) on the device (window.devicePixelRatio).
True if browser supports Canvas.
+Indicates if DeviceOrientation is supported in the user's browser.
+Is HTML5 geolocation supported in the current browser?
+True if browser supports touch events.
+True if browser supports WebGL.
+ OpenLayers 3
+ A mutable MVC Array.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
array |
+
+
+ + + +Array + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Array. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
length |
+ + + +number + + + + | +no | +change:length |
+ the length of the array | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Remove all elements from the collection.
+Dispatches a change event. Register a listener for this event to get
+notified of changes.
| 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. |
+
this |
+
+
+ + + +S + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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.
+Get an object of all property names and values.
+Object.
+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 name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ The element that is added to or removed from the collection.
+Triggered when an item is added to the collection.
+Triggered when an item is removed from the collection.
+ OpenLayers 3
+ The ol.DeviceOrientation class provides access to DeviceOrientation +information and events, see the HTML 5 DeviceOrientation Specification 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 |
+
+
+ + + +olx.DeviceOrientationOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
alpha |
+ + + +number + + + + | +no | +change:alpha |
+ the euler angle in radians of the + device from the standard X axis | +
beta |
+ + + +number + + + + | +no | +change:beta |
+ the euler angle in radians of the + device from the planar Z axis | +
gamma |
+ + + +number + + + + | +no | +change:gamma |
+ the euler angle in radians of the + device from the planar X axis | +
heading |
+ + + +number + + + + | +no | +change:heading |
+ the euler angle in radians of the + device from the planar Y axis | +
tracking |
+ + + +boolean + + + + | +yes | +change:tracking |
+ the status of tracking changes to alpha, + beta and gamma. If true, changes are tracked and reported immediately. | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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.
+Get an object of all property names and values.
+Object.
+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 name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Object representing a dragbox event.
The coordinate of the drag event.
+Triggered upon drag box start.
+Triggered upon drag box end.
+ OpenLayers 3
+ The feature being drawn.
+Triggered upon feature draw end
+Triggered upon feature draw start
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
geometryOrValues |
+
+
+ + + +ol.geom.Geometry +| + +Object.<string, *>= + + + + | + + + + + +Values or geometry. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Geometry.
+Geometry property name.
+Id.
+Get an object of all property names and values.
+Object.
+User provided style.
+Style function.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
geometry |
+
+
+ + + +ol.geom.Geometry +| + +undefined + + + + | + + + + + +Geometry. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
name |
+
+
+ + + +string + + + + | + + + + + +Geometry property name. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
id |
+
+
+ + + +number +| + +string +| + +undefined + + + + | + + + + + +Id. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.FeatureStyleFunction + + + + | + + + + + +Feature style. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.FeatureOverlayOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
Features collection.
+Get the style for features. This returns whatever was passed to the style
+option at construction or to the setStyle method.
Overlay style.
+Get the style function.
+Style function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +ol.Collection + + + + | + + + + + +Features collection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map + + + + | + + + + + +Map. |
+
Set the style for features. This can be a single style object, an array +of styles, or a function that takes a feature and resolution and returns +an array of styles.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction + + + + | + + + + + +Overlay style. |
+
OpenLayers 3
+ 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', function(evt) {
+ window.console.log(geolocation.getPosition());
+});| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.GeolocationOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
accuracy |
+ + + +number + + + + | +no | +change:accuracy |
+ the accuracy of the position + measurement in meters | +
accuracyGeometry |
+ + + +ol.geom.Geometry + + + + | +no | +change:accuracygeometry |
+ a + geometry of the position accuracy. | +
altitude |
+ + + +number + + + + | +no | +change:altitude |
+ the altitude of the position in + meters above mean sea level | +
altitudeAccuracy |
+ + + +number + + + + | +no | +change:altitudeaccuracy |
+ the accuracy of the + altitude measurement in meters | +
heading |
+ + + +number + + + + | +no | +change:heading |
+ the heading of the device in + radians from north | +
position |
+ + + +ol.Coordinate + + + + | +no | +change:position |
+ the current position of + the device reported in the current projection | +
projection |
+ + + +ol.proj.Projection + + + + | +no | +change:projection |
+ the projection to + report the position in | +
speed |
+ + + +number + + + + | +no | +change:speed |
+ the instantaneous speed of the + device in meters per second | +
tracking |
+ + + +number + + + + | +yes | +change:tracking |
+ track the device's position. | +
trackingOptions |
+ + + +GeolocationPositionOptions + + + + | +yes | +change:trackingoptions |
+ PositionOptions + as defined by the HTML5 Geolocation spec at + http://dev.w3.org/geo/api/spec-source.html | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the accuracy of the position in meters.
+Position accuracy in meters.
+Get a geometry of the position accuracy.
+Accuracy geometry.
+Get the altitude associated with the position.
+The altitude in meters above the mean sea level.
+Get the altitude accuracy of the position.
+Altitude accuracy in meters.
+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 an object of all property names and values.
+Object.
+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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Set the projection to use for transforming the coordinates.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Projection. |
+
Enable/disable tracking.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean + + + + | + + + + + +Enable or disable tracking. |
+
Set the tracking options.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +GeolocationPositionOptions + + + + | + + + + + +HTML 5 Geolocation +tracking options. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
decay |
+
+
+ + + +number + + + + | + + + + + +Rate of decay (must be negative). |
+
minVelocity |
+
+
+ + + +number + + + + | + + + + + +Minimum velocity (pixels/millisecond). |
+
delay |
+
+
+ + + +number + + + + | + + + + + +Delay to consider to calculate the kinetic + initial values (milliseconds). |
+
OpenLayers 3
+ 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.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.MapOptions + + + + | + + + + + +Map options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
layergroup |
+ + + +ol.layer.LayerGroup + + + + | +yes | +change:layergroup |
+ a layer group containing + the layers in this map. | +
size |
+ + + +ol.Size + + + + | +yes | +change:size |
+ the size in pixels of the map in the DOM | +
target |
+ + + +string +| + +Element + + + + | +yes | +change:target |
+ the Element or id of the Element + that the map is rendered in. | +
view |
+ + + +ol.IView + + + + | +yes | +change:view |
+ the view that controls this map | +
Add the given control to the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
control |
+
+
+ + + +ol.control.Control + + + + | + + + + + +Control. |
+
Add the given interaction to the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
interaction |
+
+
+ + + +ol.interaction.Interaction + + + + | + + + + + +Interaction to add. |
+
Adds the given layer to the top of this map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +ol.layer.Base + + + + | + + + + + +Layer. |
+
Add the given overlay to the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
overlay |
+
+
+ + + +ol.Overlay + + + + | + + + + + +Overlay. |
+
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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
var_args |
+
+
+ + + +ol.PreRenderFunction + + + + | + + + + + +Any number of pre-render functions. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
pixel |
+
+
+ + + +ol.Pixel + + + + | + + ++ + + + | + + + + +Pixel. |
+
callback |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Feature + callback. |
+
this |
+
+
+ + + +S + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Value to use as |
+
layerFilter |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Layer
+ filter function, only layers which are visible and for which this
+ function returns |
+
this2 |
+
+
+ + + +U + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Value to use as |
+
Callback result.
+Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Controls.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixel |
+
+
+ + + +ol.Pixel + + + + | + + + + + +Pixel. |
+
Coordinate.
+Returns the geographical coordinate for a browser event.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
event |
+
+
+ + + +Event + + + + | + + + + + +Event. |
+
Coordinate.
+Returns the map pixel position for a browser event.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
event |
+
+
+ + + +Event + + + + | + + + + + +Event. |
+
Pixel.
+Gets the collection of +ol.interaction.Interaction instances +associated with this map. Modifying this collection +changes the interactions associated with the 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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Pixel.
+Get an object of all property names and values.
+Object.
+Get the size of this map.
+Size.
+Get the target in which this map is rendered. +Note that this returns what is entered as an option or in setTarget: +if that was an element, it returns an element; if a string, it returns that.
+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.
+Viewport.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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.
+Remove the given interaction from the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
interaction |
+
+
+ + + +ol.interaction.Interaction + + + + | + + + + + +Interaction to remove. |
+
The removed interaction (or + undefined if the interaction was not found).
+Removes the given layer from the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +ol.layer.Base + + + + | + + + + + +Layer. |
+
The removed layer or undefined if the + layer was not found.
+Remove the given overlay from the map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
overlay |
+
+
+ + + +ol.Overlay + + + + | + + + + + +Overlay. |
+
The removed overlay of undefined + if the overlay was not found.
+Request that renderFrame_ be called some time in the future.
+Render.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Sets the layergroup of this map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layerGroup |
+
+
+ + + +ol.layer.Group + + + + | + + + + + +Layergroup. |
+
Set the size of this map.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
size |
+
+
+ + + +ol.Size +| + +undefined + + + + | + + + + + +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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
view |
+
+
+ + + +ol.IView + + + + | + + + + + +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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
Force a recalculation of the map viewport size. This should be called when +third-party code changes the size of the map viewport.
+ OpenLayers 3
+ Prevents the default browser action.
+Prevents further propagation of the current event.
+A true double click, with no dragging.
+Triggered after the map is moved.
+Triggered when a pointer is dragged.
+Triggered when a pointer is moved.
+Triggered after a map frame is rendered.
+A true single click with no dragging and no double click. Note that this +event is delayed by 250 ms to ensure that it is not a double click.
+ OpenLayers 3
+ Triggered after the map is moved.
+Triggered after a map frame is rendered.
+ OpenLayers 3
+ Base class implementing KVO (Key Value Observing).
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
values |
+
+
+ + + +Object.<string, *>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Values. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Object representing a property change event.
The name of the property whose value is changing.
+Triggered before a property is changed.
+Triggered when a property is changed.
+ OpenLayers 3
+ An event target providing convenient methods for listener registration
+and unregistration. A generic change event is always available through
+ol.Observable#dispatchChangeEvent.
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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);
+map.addOverlay(popup);| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.OverlayOptions + + + + | + + + + + +Overlay options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
element |
+ + + +Element + + + + | +yes | +change:element |
+ the Element containing the overlay | +
map |
+ + + +ol.Map + + + + | +yes | +change:map |
+ the map that the overlay is part of | +
position |
+ + + +ol.Coordinate + + + + | +yes | +change:position |
+ the spatial point that the overlay + is anchored at | +
positioning |
+ + + +ol.OverlayPositioning + + + + | +yes | +change:positioning |
+ how the overlay is + positioned relative to its point on the map | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Set the DOM element to be associated with this overlay.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
element |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Element. |
+
Set the map to be associated with this overlay.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
map |
+
+
+ + + +ol.Map +| + +undefined + + + + | + + + + + +Map. |
+
Set the position for this overlay.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
position |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +Position. |
+
Set the positioning for this overlay.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
positioning |
+
+
+ + + +ol.OverlayPositioning +| + +undefined + + + + | + + + + + +Positioning. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
result |
+
+
+ + + +Array.<number>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Optional array to reuse. |
+
Array of z, x, y.
+Hash.
+ OpenLayers 3
+ 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 |
+
+
+ + + +olx.View2DOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ View2D options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
center |
+ + + +ol.Coordinate + + + + | +yes | +change:center |
+ the center of the view | +
projection |
+ + + +ol.proj.Projection + + + + | +yes | +change:projection |
+ the projection of the view | +
resolution |
+ + + +number + + + + | +yes | +change:resolution |
+ the resolution of the view | +
rotation |
+ + + +number + + + + | +yes | +change:rotation |
+ the rotation of the view | +
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.
+Center on coordinate and view position. +Take care on the map angle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
size |
+
+
+ + + +ol.Size + + + + | + + + + + +Box pixel size. |
+
position |
+
+
+ + + +ol.Pixel + + + + | + + + + + +Position on the view to center on. |
+
Get the constrained the resolution of this view.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
resolution |
+
+
+ + + +number +| + +undefined + + + + | + + ++ + + + | + + + + +Resolution. |
+
delta |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Delta. Default is |
+
direction |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Direction. Default is |
+
Constrained resolution.
+Get the constrained rotation of this view.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + ++ + + + | + + + + +Rotation. |
+
delta |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Delta. Default is |
+
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. |
+
Fit the given geometry based on the given map size and border. +Take care on the map angle.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
geometry |
+
+
+ + + +ol.geom.SimpleGeometry + + + + | + + ++ + + + | + + + + +Geometry. |
+
size |
+
+
+ + + +ol.Size + + + + | + + ++ + + + | + + + + +Box pixel size. |
+
options |
+
+
+ + + +olx.View2D.fitGeometryOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
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. +Warning! This code is not yet implemented. Function should not be used.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.proj.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. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.animation.BounceOptions + + + + | + + + + + +Bounce options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.animation.PanOptions + + + + | + + + + + +Pan options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.animation.RotateOptions + + + + | + + + + + +Rotate options. |
+
Pre-render function.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.animation.ZoomOptions + + + + | + + + + + +Zoom options. |
+
Pre-render function.
+ OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.AttributionOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Attribution options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Something to be painted over the map to provide a means for interaction +(buttons) or to show annotations (status bars).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.control.ControlOptions + + + + | + + + + + +Control options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.FullScreenOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.LogoOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Logo options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.MousePositionOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Mouse position + options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
projection |
+ + + +ol.proj.Projection + + + + | +yes | +change:projection |
+ the projection to report + mouse position in | +
coordinateFormat |
+ + + +ol.CoordinateFormatType + + + + | +yes | +change:coordinateformat |
+ the format to + render the current position in | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+projection.
+Get the map associated with this control.
+Map.
+projection.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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.proj.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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Create a control to help users estimate distances on a map.
+By default it will show in the bottom left portion of the map, but it can
+be changed by using a css selector for .ol-scale-line.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.control.ScaleLineOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Scale line options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
units |
+ + + +ol.control.ScaleLineUnits + + + + | +yes | +change:units |
+ the units to use in the + scale line | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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 name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.ZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Zoom options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ A slider type of control for zooming.
+Example:
+map.addControl(new ol.control.ZoomSlider());| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.control.ZoomSliderOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Zoom slider options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ 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 |
+
+
+ + + +olx.control.ZoomToExtentOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Get the map associated with this control.
+Map.
+Get an object of all property names and values.
+Object.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
DEGREES |
+
+
+ + + +string + + + + | + + + + ++ + degrees + + | + + ++ |
IMPERIAL |
+
+
+ + + +string + + + + | + + + + ++ + imperial + + | + + ++ |
NAUTICAL |
+
+
+ + + +string + + + + | + + + + ++ + nautical + + | + + ++ |
METRIC |
+
+
+ + + +string + + + + | + + + + ++ + metric + + | + + ++ |
US |
+
+
+ + + +string + + + + | + + + + ++ + us + + | + + ++ |
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.control.DefaultsOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Defaults options. |
+
Controls.
+ OpenLayers 3
+ 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');| Name | + + +Type | + + + + + +Description | +
|---|---|---|
target |
+
+
+ + + +Element + + + + | + + + + + +Target element. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
value |
+ + + +string + + + + | +yes | +change:value |
+ the value of the Input | +
checked |
+ + + +boolean + + + + | +yes | +change:checked |
+ the checked state of the Input | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+If the input is a checkbox, return whether or not the checbox is checked.
+checked.
+Get an object of all property names and values.
+Object.
+Get the value of the input.
+input 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 name. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Set whether or not a checkbox is checked.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
checked |
+
+
+ + + +boolean + + + + | + + + + + +Checked. |
+
Sets the value of the input.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
value |
+
+
+ + + +string + + + + | + + + + + +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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Always true.
+Always false.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True if only the alt key is pressed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True if only the alt and shift keys are pressed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True only if there no modifier keys are pressed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True if only the platform modifier key is pressed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True if only the shift key is pressed.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
mapBrowserEvent |
+
+
+ + + +ol.MapBrowserEvent + + + + | + + + + + +Map browser event. |
+
True only if the target element is not editable.
+ OpenLayers 3
+ A function that takes a {number} representing the view's resolution. It
+returns an Array of ol.style.Style. This way individual features
+can be styled. The this keyword inside the function references the
+ol.Feature to be styled.
A function that takes an ol.Feature and a {number} representing
+the view's resolution. The function should return an array of
+ol.style.Style. This way e.g. a vector layer can be styled.
OpenLayers 3
+ ol.format.Feature subclasses provide the ability to decode and encode +ol.Feature objects from a variety of commonly used geospatial +file formats. See the documentation for each format for more details.
+ OpenLayers 3
+ Read the projection from a GPX source.
+Read the first feature from a GPX source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Feature.
+Read all features from a GPX source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Features.
+Encode an array of features in the GPX format.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Result.
+ OpenLayers 3
+ Provide access to features stored in the GeoJSON format.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.format.GeoJSONOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Read a feature from a GeoJSON Feature source. This method will throw +an error if used with a FeatureCollection source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Feature.
+Read all features from a GeoJSON source. Works with both Feature and +FeatureCollection sources.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Features.
+Read a geometry from a GeoJSON source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Geometry.
+Read the projection from the GeoJSON source file.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
object |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Projection.
+Encode a feature as a GeoJSON Feature object.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
Result.
+Encode an array of features as GeoJSON.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Result.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.format.IGCOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Read the feature from the IGC source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Feature.
+Read the feature from the source. As IGC sources contain a single +feature, this will return the feature in an array.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Features.
+Read the projection from the IGC source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Projection.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.format.KMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Read the first feature from a KML source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Feature.
+Read all features from a KML source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +Document +| + +Node +| + +string + + + + | + + + + + +Souce. |
+
Name.
+Read the projection from a KML source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Projection.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.format.TopoJSONOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Read all features from a TopoJSON source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Features.
+Read the projection from a TopoJSON source.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
object |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Projection.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.format.WFSOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Optional configuration object. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
FeatureCollection metadata.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
source |
+
+
+ + + +ArrayBuffer +| + +Document +| + +Node +| + +Object +| + +string + + + + | + + + + + +Source. |
+
Transaction response.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.format.WFSWriteGetFeatureOptions + + + + | + + + + + +Options. |
+
Result.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
inserts |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +The features to insert. |
+
updates |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +The features to update. |
+
deletes |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +The features to delete. |
+
options |
+
+
+ + + +olx.format.WFSWriteTransactionOptions + + + + | + + + + + +Write options. |
+
Result.
+ OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
center |
+
+
+ + + +ol.geom.RawPoint + + + + | + + ++ + + + | + + + + +Center. |
+
radius |
+
+
+ + + +number + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Radius. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + ++ + + + | + + + + +Layout. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Center.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+First coordinate.
+Last point.
+Layout.
+Radius.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
center |
+
+
+ + + +ol.geom.RawPoint + + + + | + + + + + +Center. |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
center |
+
+
+ + + +ol.geom.RawPoint + + + + | + + ++ + + + | + + + + +Center. |
+
radius |
+
+
+ + + +number + + + + | + + ++ + + + | + + + + +Radius. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
radius |
+
+
+ + + +number + + + + | + + + + + +Radius. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
geometries |
+
+
+ + + +Array.<ol.geom.Geometry>= + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Geometries. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Geometries.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
geometries |
+
+
+ + + +Array.<ol.geom.Geometry> + + + + | + + + + + +Geometries. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawLineString + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Returns the coordinate at m using linear interpolation, or null if no
+such coordinate exists.
opt_extrapolate controls extrapolation beyond the range of Ms in the
+MultiLineString. If opt_extrapolate is true then Ms less than the first
+M will return the first coordinate and Ms greater than the last M will
+return the last coordinate.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
m |
+
+
+ + + +number + + + + | + + ++ + + + | + + + + +M. |
+
extrapolate |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Extrapolate. |
+
Coordinate.
+Coordinates.
+First coordinate.
+Last point.
+Layout.
+Length.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawLineString + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawLinearRing + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Area.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Coordinates.
+First coordinate.
+Last point.
+Layout.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawLinearRing + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiLineString + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
lineString |
+
+
+ + + +ol.geom.LineString + + + + | + + + + + +LineString. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Returns the coordinate at m using linear interpolation, or null if no
+such coordinate exists.
opt_extrapolate controls extrapolation beyond the range of Ms in the
+MultiLineString. If opt_extrapolate is true then Ms less than the first
+M will return the first coordinate and Ms greater than the last M will
+return the last coordinate.
opt_interpolate controls interpolation between consecutive LineStrings
+within the MultiLineString. If opt_interpolate is true the coordinates
+will be linearly interpolated between the last coordinate of one LineString
+and the first coordinate of the next LineString. If opt_interpolate is
+false then the function will return null for Ms falling between
+LineStrings.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
m |
+
+
+ + + +number + + + + | + + ++ + + + | + + + + +M. |
+
extrapolate |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Extrapolate. |
+
interpolate |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Interpolate. |
+
Coordinate.
+Coordinates.
+First coordinate.
+Last point.
+Layout.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
LineString.
+LineStrings.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiLineString + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiPoint + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.geom.Point + + + + | + + + + + +Point. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Coordinates.
+First coordinate.
+Last point.
+Layout.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
Point.
+Points.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiPoint + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiPolygon + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
polygon |
+
+
+ + + +ol.geom.Polygon + + + + | + + + + + +Polygon. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Area.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Coordinates.
+First coordinate.
+Interior points.
+Last point.
+Layout.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
Polygon.
+Polygons.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawMultiPolygon + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawPoint + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Coordinates.
+First coordinate.
+Last point.
+Layout.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawPoint + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawPolygon + + + + | + + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout +| + +string + + + + | + + + + + +Layout. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
linearRing |
+
+
+ + + +ol.geom.LinearRing + + + + | + + + + + +Linear ring. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Area.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+Coordinates.
+First coordinate.
+Interior point.
+Last point.
+Layout.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
index |
+
+
+ + + +number + + + + | + + + + + +Index. |
+
Linear ring.
+Linear rings.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
coordinates |
+
+
+ + + +ol.geom.RawPolygon + + + + | + + ++ + + + | + + + + +Coordinates. |
+
layout |
+
+
+ + + +ol.geom.GeometryLayout + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layout. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + ++ + + + | + + + + +Point. |
+
closestPoint |
+
+
+ + + +ol.Coordinate + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Closest point. |
+
Closest point.
+First coordinate.
+Last point.
+Layout.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
XY |
+
+
+ + + +string + + + + | + + + + ++ + XY + + | + + ++ |
XYZ |
+
+
+ + + +string + + + + | + + + + ++ + XYZ + + | + + ++ |
XYM |
+
+
+ + + +string + + + + | + + + + ++ + XYM + + | + + ++ |
XYZM |
+
+
+ + + +string + + + + | + + + + ++ + XYZM + + | + + ++ |
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
POINT |
+
+
+ + + +string + + + + | + + + + ++ + Point + + | + + ++ |
LINE_STRING |
+
+
+ + + +string + + + + | + + + + ++ + LineString + + | + + ++ |
LINEAR_RING |
+
+
+ + + +string + + + + | + + + + ++ + LinearRing + + | + + ++ |
POLYGON |
+
+
+ + + +string + + + + | + + + + ++ + Polygon + + | + + ++ |
MULTI_POINT |
+
+
+ + + +string + + + + | + + + + ++ + MultiPoint + + | + + ++ |
MULTI_LINE_STRING |
+
+
+ + + +string + + + + | + + + + ++ + MultiLineString + + | + + ++ |
MULTI_POLYGON |
+
+
+ + + +string + + + + | + + + + ++ + MultiPolygon + + | + + ++ |
GEOMETRY_COLLECTION |
+
+
+ + + +string + + + + | + + + + ++ + GeometryCollection + + | + + ++ |
CIRCLE |
+
+
+ + + +string + + + + | + + + + ++ + Circle + + | + + ++ |
OpenLayers 3
+ 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_CENTER |
+
+
+ + + +string + + + + | + + + + ++ + bottom-center + + | + + ++ |
BOTTOM_RIGHT |
+
+
+ + + +string + + + + | + + + + ++ + bottom-right + + | + + ++ |
CENTER_LEFT |
+
+
+ + + +string + + + + | + + + + ++ + center-left + + | + + ++ |
CENTER_CENTER |
+
+
+ + + +string + + + + | + + + + ++ + center-center + + | + + ++ |
CENTER_RIGHT |
+
+
+ + + +string + + + + | + + + + ++ + center-right + + | + + ++ |
TOP_LEFT |
+
+
+ + + +string + + + + | + + + + ++ + top-left + + | + + ++ |
TOP_CENTER |
+
+
+ + + +string + + + + | + + + + ++ + top-center + + | + + ++ |
TOP_RIGHT |
+
+
+ + + +string + + + + | + + + + ++ + top-right + + | + + ++ |
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
CANVAS |
+
+
+ + + +string + + + + | + + + + ++ + canvas + + | + + ++ |
DOM |
+
+
+ + + +string + + + + | + + + + ++ + dom + + | + + ++ |
WEBGL |
+
+
+ + + +string + + + + | + + + + ++ + webgl + + | + + ++ |
Interface for views. Currently ol.View2D is implemented.
+A function returning the canvas element ({HTMLCanvasElement})
+used by the source as an image. The arguments passed to the function are:
+ol.Extent the image extent, {number} the image resolution,
+{number} the device pixel ratio, ol.Size the image size, and
+ol.proj.Projection the image projection. The canvas returned by
+this function is cached by the source. The this keyword inside the function
+references the ol.source.ImageCanvas.
A color represented as a short array [red, green, blue, alpha]. +red, green, and blue should be integers in the range 0..255 inclusive. +alpha should be a float in the range 0..1 inclusive.
+An array of numbers representing a coordinate.
+A function that takes a ol.Coordinate and transforms it into a
+{string}.
An array of numbers representing an extent: [minx, miny, maxx, maxy].
An array of numbers representing a size: [width, height].
A function that takes an ol.ImageTile for the image tile and a
+{string} for the src as arguments.
A function that takes an ol.TileCoord for the tile coordinate,
+a {number} representing the pixel ratio and an ol.proj.Projection
+for the projection as arguments and returns a {string} or
+undefined representing the tile URL. The this keyword inside the function
+references the ol.source.TileImage.
A transform function accepts an array of input coordinate values, an optional +output array, and an optional dimension (default should be 2). The function +transforms the input coordinate values, populates the output array, and +returns the output array.
+ OpenLayers 3
+ Allows the user to zoom by double-clicking on the map.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DoubleClickZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragAndDropOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Triggered when features are added
+ OpenLayers 3
+ Allows the user to zoom the map by clicking and dragging on the map, +normally combined with an ol.events.condition that limits +it to when the shift key is held down.
+This interaction is only supported for mouse devices.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragBoxOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Returns geometry of last drawn box.
+Geometry.
+ OpenLayers 3
+ Allows the user to pan the map by dragging the map.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragPanOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
OpenLayers 3
+ Allows the user to rotate the map by clicking and dragging on the map, +normally combined with an ol.events.condition that limits +it to when the alt and shift keys are held down.
+This interaction is only supported for mouse devices.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragRotateOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
OpenLayers 3
+ Allows the user to zoom and rotate the map by clicking and dragging +on the map. By default, this interaction is limited to when the shift +key is held down.
+This interaction is only supported for mouse devices.
+And this interaction is not included in the default interactions.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragRotateAndZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
OpenLayers 3
+ Allows the user to zoom the map by clicking and dragging on the map, +normally combined with an ol.events.condition that limits +it to when the shift key is held down.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DragZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Returns geometry of last drawn box.
+Geometry.
+ OpenLayers 3
+ Interaction that allows drawing geometries
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.interaction.DrawOptions + + + + | + + + + + +Options. |
+
OpenLayers 3
+ Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Allows the user to pan the map using keyboard arrows.
+Note that, although this interaction is by default included in maps,
+the keys can only be used when browser focus is on the element to which
+the keyboard events are attached. By default, this is the map div,
+though you can change this with the keyboardTargetElement in
+ol.Map. document never loses focus but, for any other element,
+focus will have to be on, and returned to, this element if the keys are to
+function.
+See also ol.interaction.KeyboardZoom.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.KeyboardPanOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Allows the user to zoom the map using keyboard + and -.
+Note that, although this interaction is by default included in maps,
+the keys can only be used when browser focus is on the element to which
+the keyboard events are attached. By default, this is the map div,
+though you can change this with the keyboardTargetElement in
+ol.Map. document never loses focus but, for any other element,
+focus will have to be on, and returned to, this element if the keys are to
+function.
+See also ol.interaction.KeyboardPan.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.KeyboardZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.interaction.ModifyOptions + + + + | + + + + + +Options. |
+
OpenLayers 3
+ Allows the user to zoom the map by scrolling the mouse wheel.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.MouseWheelZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ Allows the user to rotate the map by twisting with two fingers +on a touch screen.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.PinchRotateOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
OpenLayers 3
+ Allows the user to zoom the map by pinching with two fingers +on a touch screen.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.PinchZoomOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.interaction.SelectOptions + + + + | + + + + + +Options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Features collection.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ This method is a convenience method to create a set of interactions +to be used with an ol.Map. Specific interactions can be excluded by +setting the appropriate option to false in the constructor options, +but the order of the interactions is fixed. If you want to specify a +different order for interactions, you will need to create your own +ol.interaction instances and insert them into an +ol.Collection in the order you want before creating your ol.Map +instance.
+| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.interaction.DefaultsOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Defaults options. |
+
A collection of interactions to be used with +the ol.Map constructor's interactions option.
+ OpenLayers 3
+ The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.layer.GroupOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Layer options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
layers |
+ + + +ol.Collection + + + + | +yes | +change:layers |
+ collection of layers that are part + of this group | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+Collection of layers.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layers |
+
+
+ + + +ol.Collection +| + +undefined + + + + | + + + + + +Collection of layers. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.layer.HeatmapOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Colors.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Source.
+Get the style for features. This returns whatever was passed to the style
+option at construction or to the setStyle method.
Layer style.
+Get the style function.
+Layer style function.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
colors |
+
+
+ + + +Array.<string> + + + + | + + + + + +Gradient. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Set the style for features. This can be a single style object, an array +of styles, or a function that takes a feature and resolution and returns +an array of styles.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction + + + + | + + + + + +Layer style. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.layer.LayerOptions + + + + | + + + + + +Layer options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Source.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.layer.LayerOptions + + + + | + + + + + +Layer options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
brightness |
+ + + +number + + + + | +yes | +change:brightness |
+ the brightness of the layer | +
contrast |
+ + + +number + + + + | +yes | +change:contrast |
+ the contrast of the layer | +
hue |
+ + + +number + + + + | +yes | +change:hue |
+ the hue of the layer | +
opacity |
+ + + +number + + + + | +yes | +change:opacity |
+ the opacity of the layer | +
saturation |
+ + + +number + + + + | +yes | +change:saturation |
+ the saturation of the layer | +
visible |
+ + + +boolean + + + + | +yes | +change:visible |
+ the visiblity of the layer | +
maxResolution |
+ + + +number + + + + | +yes | +change:maxresolution |
+ the maximum resolution of the layer | +
minResolution |
+ + + +number + + + + | +yes | +change:minresolution |
+ the minimum resolution of the layer | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Source.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.layer.TileOptions + + + + | + + + + + +Tile layer options. |
+
| Name | +Type | +Settable | +ol.ObjectEvent type | +Description | +
|---|---|---|---|---|
preload |
+ + + +number + + + + | +yes | +change:preload |
+ the level to preload tiles up to | +
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Preload.
+Get an object of all property names and values.
+Object.
+Saturation.
+Source.
+Use interim tiles on error.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
preload |
+
+
+ + + +number + + + + | + + + + + +Preload. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
useInterimTilesOnError |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Use interim tiles on error. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.layer.VectorOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
The bindTo method allows you to set up a two-way binding between a
+source and target object. The method returns an
+ol.ObjectAccessor with a transform method that lets you transform
+values on the way from the source to the target and on the way back.
For example, if you had two map views (sourceView and targetView) +and you wanted the target view to have double the resolution of the +source view, you could transform the resolution on the way to and +from the target with the following:
+sourceView.bindTo('resolution', targetView)
+ .transform(
+ function(sourceResolution) {
+ // from sourceView.resolution to targetView.resolution
+ return 2 * sourceResolution;
+ },
+ function(targetResolution) {
+ // from targetView.resolution to sourceView.resolution
+ return targetResolution / 2;
+ }
+ );| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
key |
+
+
+ + + +string + + + + | + + ++ + + + | + + + + +Key name. |
+
target |
+
+
+ + + +ol.Object + + + + | + + ++ + + + | + + + + +Target. |
+
targetKey |
+
+
+ + + +string + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Target key. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Gets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
Value.
+Brightness.
+Contrast.
+Hue.
+MaxResolution.
+MinResolution.
+Opacity.
+Get an object of all property names and values.
+Object.
+Saturation.
+Source.
+Get the style for features. This returns whatever was passed to the style
+option at construction or to the setStyle method.
Layer style.
+Get the style function.
+Layer style function.
+Visible.
+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. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+Sets a value.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +Key name. |
+
value |
+
+
+ + + +* + + + + | + + + + + +Value. |
+
Adjust the layer brightness. A value of -1 will render the layer completely +black. A value of 0 will leave the brightness unchanged. A value of 1 will +render the layer completely white. Other values are linear multipliers on +the effect (values are clamped between -1 and 1).
+The filter effects draft [1] says the brightness function is supposed to +render 0 black, 1 unchanged, and all other values as a linear multiplier.
+The current WebKit implementation clamps values between -1 (black) and 1 +(white) [2]. There is a bug open to change the filter effect spec [3].
+TODO: revisit this if the spec is still unmodified before we release
+[1] https://dvcs.w3.org/hg/FXTF/raw-file/tip/filters/index.html +[2] https://github.com/WebKit/webkit/commit/8f4765e569 +[3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
Adjust the layer contrast. A value of 0 will render the layer completely +grey. A value of 1 will leave the contrast unchanged. Other values are +linear multipliers on the effect (and values over 1 are permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
Apply a hue-rotation to the layer. A value of 0 will leave the hue +unchanged. Other values are radians around the color circle.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MaxResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +MinResolution. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. |
+
Adjust layer saturation. A value of 0 will render the layer completely +unsaturated. A value of 1 will leave the saturation unchanged. Other +values are linear multipliers of the effect (and values over 1 are +permitted).
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
Set the style for features. This can be a single style object, an array +of styles, or a function that takes a feature and resolution and returns +an array of styles.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction + + + + | + + + + + +Layer style. |
+
Sets a collection of key-value pairs.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
values |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +Values. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visible. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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 name. |
+
Removes all bindings.
+Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.ProjectionOptions + + + + | + + + + + +Projection options. |
+
Get the code for this projection, e.g. 'EPSG:4326'.
+Code.
+Get the validity extent for this projection.
+Extent.
+Get the units of this projection.
+Units.
+ OpenLayers 3
+ | Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
DEGREES |
+
+
+ + + +string + + + + | + + + + ++ + degrees + + | + + ++ |
FEET |
+
+
+ + + +string + + + + | + + + + ++ + ft + + | + + ++ |
METERS |
+
+
+ + + +string + + + + | + + + + ++ + m + + | + + ++ |
PIXELS |
+
+
+ + + +string + + + + | + + + + ++ + pixels + + | + + ++ |
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.Proj4jsProjectionOptions + + + + | + + + + + +Proj4js projection options. |
+
Proj4js projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
projectionLike |
+
+
+ + + +ol.proj.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.proj.ProjectionLike + + + + | + + + + + +Source. |
+
destination |
+
+
+ + + +ol.proj.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.proj.Projection + + + + | + + + + + +Source projection. |
+
destinationProjection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Destination projection. |
+
Transform.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Point. |
+
source |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Source. |
+
destination |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination. |
+
Point.
+Transforms the given point to the destination projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
point |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Point. |
+
sourceProjection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Source projection. |
+
destinationProjection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Destination projection. |
+
Point.
+A projection as ol.proj.Projection, SRS identifier string or +undefined.
+ OpenLayers 3
+ Canvas context. Only available when a Canvas renderer is used, +null otherwise.
+WebGL context. Only available when a WebGL renderer is used, null +otherwise.
+ OpenLayers 3
+ Register a function to be called for rendering at a given zIndex. The +function will be called asynchronously. The callback will receive a +reference to ol.render.canvas.Immediate context for drawing.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
zIndex |
+
+
+ + + +number + + + + | + + + + + +Z index. |
+
callback |
+
+
+ + + +function + + + + | + + + + + +Callback. |
+
Render a circle geometry into the canvas. Rendering is immediate and uses +the current fill and stroke styles.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
circleGeometry |
+
+
+ + + +ol.geom.Circle + + + + | + + + + + +Circle geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object, |
+
Render a feature into the canvas. In order to respect the zIndex of the +style this method draws asynchronously and thus after calls to +drawXxxxGeometry have been finished, effectively drawing the feature +on top of everything else. You probably should be using +ol.FeatureOverlay instead of calling this method directly.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
style |
+
+
+ + + +ol.style.Style + + + + | + + + + + +Style. |
+
Render a LineString into the canvas. Rendering is immediate and uses +the current style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
lineStringGeometry |
+
+
+ + + +ol.geom.LineString + + + + | + + + + + +Line string geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object. |
+
Render a MultiLineString geometry into the canvas. Rendering is immediate +and uses the current style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
multiLineStringGeometry |
+
+
+ + + +ol.geom.MultiLineString + + + + | + + + + + +MultiLineString geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object. |
+
Render a MultiPoint geometry into the canvas. Rendering is immediate and +uses the current style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
multiPointGeometry |
+
+
+ + + +ol.geom.MultiPoint + + + + | + + + + + +MultiPoint geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object. |
+
Render a Point geometry into the canvas. Rendering is immediate and uses +the current style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pointGeometry |
+
+
+ + + +ol.geom.Point + + + + | + + + + + +Point geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object. |
+
Render a Polygon geometry into the canvas. Rendering is immediate and uses +the current style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
polygonGeometry |
+
+
+ + + +ol.geom.Polygon + + + + | + + + + + +Polygon geometry. |
+
data |
+
+
+ + + +Object + + + + | + + + + + +Opaque data object. |
+
Set the fill and stroke style for subsequent draw operations. To clear +either fill or stroke styles, pass null for the appropriate parameter.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
fillStyle |
+
+
+ + + +ol.style.Fill + + + + | + + + + + +Fill style. |
+
strokeStyle |
+
+
+ + + +ol.style.Stroke + + + + | + + + + + +Stroke style. |
+
Set the image style for subsequent draw operations. Pass null to remove +the image style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
imageStyle |
+
+
+ + + +ol.style.Image + + + + | + + + + + +Image style. |
+
Set the text style for subsequent draw operations. Pass null to +remove the text style.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
textStyle |
+
+
+ + + +ol.style.Text + + + + | + + + + + +Text style. |
+
OpenLayers 3
+ OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.BingMapsOptions + + + + | + + + + + +Bing Maps options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.GPXOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.GeoJSONOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.IGCOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.ImageCanvasOptions + + + + | + + + + + ++ |
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.ImageStaticOptions + + + + | + + + + + +Options. |
+
OpenLayers 3
+ An image source whose images are canvas elements into which vector features
+read from a vector source (ol.source.Vector) are drawn. An
+ol.source.ImageVector object is to be used as the source of an image
+layer (ol.layer.Image). Image layers are rotated, scaled, and translated,
+as opposed to being re-rendered, during animations and interactions. So, like
+any other image layer, an image layer configured with an
+ol.source.ImageVector will exhibit this behaviour. This is in contrast to a
+vector layer, where vector features are re-drawn during animations and
+interactions.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.ImageVectorOptions + + + + | + + + + + +Options. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.ImageWMSOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Return the GetFeatureInfo URL for the passed coordinate, resolution, and
+projection. Return undefined if the GetFeatureInfo URL cannot be
+constructed.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
resolution |
+
+
+ + + +number + + + + | + + + + + +Resolution. |
+
projection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Projection. |
+
params |
+
+
+ + + +Object + + + + | + + + + + +GetFeatureInfo params. |
+
GetFeatureInfo URL.
+Get the user-provided params, i.e. those passed to the constructor through +the "params" option, and possibly updated using the updateParams method.
+Params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
Update the user-provided params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
params |
+
+
+ + + +Object + + + + | + + + + + +Params. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.KMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.MapGuideOptions + + + + | + + + + + +Options. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.MapQuestOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ MapQuest options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.OSMOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Open Street Map options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.OSMXMLOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.SourceOptions + + + + | + + + + + +Source options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Extent.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.StamenOptions + + + + | + + + + + +Stamen options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.source.TileOptions + + + + | + + + + + +Tile source options. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
Extent.
+State.
+Tile grid.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.TileDebugOptions + + + + | + + + + + +Debug tile options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.TileImageOptions + + + + | + + + + + +Image tile options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.TileJSONOptions + + + + | + + + + + +TileJSON options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.TileWMSOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Tile WMS options. |
+
Return the GetFeatureInfo URL for the passed coordinate, resolution, and
+projection. Return undefined if the GetFeatureInfo URL cannot be
+constructed.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
resolution |
+
+
+ + + +number + + + + | + + + + + +Resolution. |
+
projection |
+
+
+ + + +ol.proj.Projection + + + + | + + + + + +Projection. |
+
params |
+
+
+ + + +Object + + + + | + + + + + +GetFeatureInfo params. |
+
GetFeatureInfo URL.
+Get the user-provided params, i.e. those passed to the constructor through +the "params" option, and possibly updated using the updateParams method.
+Params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+Update the user-provided params.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
params |
+
+
+ + + +Object + + + + | + + + + + +Params. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.TopoJSONOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.VectorOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Vector source options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ The feature being added or removed.
+Triggered when a feature is added to the source.
+Triggered when a feature is removed from the source.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.VectorFileOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> + + + + | + + + + + +Features. |
+
Dispatches a change event. Register a listener for this event to get
+notified of changes.
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
extent |
+
+
+ + + +ol.Extent + + + + | + + ++ + + + | + + + + +Extent. |
+
f |
+
+
+ + + +function + + + + | + + ++ + + + | + + + + +Callback. |
+
this |
+
+
+ + + +T + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Closest feature.
+Extent.
+Features.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
coordinate |
+
+
+ + + +ol.Coordinate + + + + | + + + + + +Coordinate. |
+
Features.
+State.
+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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Unique key for the listener.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
feature |
+
+
+ + + +ol.Feature + + + + | + + + + + +Feature. |
+
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. |
+
this |
+
+
+ + + +Object + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ The object to use as |
+
Removes an event listener using the key returned by on() or once().
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +goog.events.Key + + + + | + + + + + +Key. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.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.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+Update the dimensions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
dimensions |
+
+
+ + + +Object + + + + | + + + + + +Dimensions. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.source.XYZOptions + + + + | + + + + + +XYZ options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string + + + + | + + + + + +URL. |
+
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.source.ZoomifyOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelRatio |
+
+
+ + + +number + + + + | + + + + + +Requested pixel ratio. |
+
Supported pixel ratio.
+Tile grid.
+ OpenLayers 3
+ | Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
LOADING |
+
+
+ + + +number + + + + | + + + + ++ + 0 + + | + + ++ |
READY |
+
+
+ + + +number + + + + | + + + + ++ + 1 + + | + + ++ |
ERROR |
+
+
+ + + +number + + + + | + + + + ++ + 2 + + | + + ++ |
| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
KVP |
+
+
+ + + +string + + + + | + + + + ++ + KVP + + | + + ++ |
REST |
+
+
+ + + +string + + + + | + + + + ++ + REST + + | + + ++ |
OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.CircleOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Fill style.
+Radius.
+Rotation.
+Scale.
+Stroke style.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.FillOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Color.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.IconOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Rotation.
+Scale.
+Image src.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +ol.style.ImageOptions + + + + | + + + + + +Options. |
+
Rotation.
+Scale.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.StrokeOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Color.
+Line cap.
+Line dash.
+Line join.
+Miter limit.
+Width.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.StyleOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Style options. |
+
Fill style.
+Image style.
+Stroke style.
+Text style.
+ZIndex.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.style.TextOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Fill style.
+Font.
+Rotation.
+Scale.
+Stroke style.
+Text.
+Text align.
+Text baseline.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.tilegrid.TileGridOptions + + + + | + + + + + +Tile grid options. |
+
Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.tilegrid.WMTSOptions + + + + | + + + + + +WMTS options. |
+
MatrixIds.
+Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
options |
+
+
+ + + +olx.tilegrid.XYZOptions + + + + | + + + + + +XYZ options. |
+
Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+ OpenLayers 3
+ | Name | + + +Type | + + +Argument | + + + + +Description | +
|---|---|---|---|
options |
+
+
+ + + +olx.tilegrid.ZoomifyOptions + + + + | + + +
+
+ <optional> + + + + |
+
+
+
+
+ Options. |
+
Min zoom.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Origin.
+Resolutions.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
z |
+
+
+ + + +number + + + + | + + + + + +Z. |
+
Tile size.
+ OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
canvas |
+
+
+ + + +HTMLCanvasElement + + + + | + + + + + +Canvas. |
+
gl |
+
+
+ + + +WebGLRenderingContext + + + + | + + + + + +GL. |
+
GL.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
program |
+
+
+ + + +WebGLProgram + + + + | + + + + + +Program. |
+
Changed.
+ OpenLayers 3
+ | 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 |
+
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 |
+
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 |
+
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. Default is |
+
easing |
+
+
+ + + +function + + + + | + + + + + +Easing function. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
element |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +The element is the control's container + element. This only needs to be specified if you're developing a custom + control. |
+
target |
+
+
+ + + +Element +| + +string +| + +undefined + + + + | + + + + + +Specify a target if you want the + control to be rendered outside of the map's viewport. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attribution |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Attribution. Default is |
+
attributionOptions |
+
+
+ + + +olx.control.AttributionOptions +| + +undefined + + + + | + + + + + +Attribution options. |
+
logo |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Logo. Default is |
+
logoOptions |
+
+
+ + + +olx.control.LogoOptions +| + +undefined + + + + | + + + + + +Logo options. |
+
zoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Zoom. Default is |
+
zoomOptions |
+
+
+ + + +olx.control.ZoomOptions +| + +undefined + + + + | + + + + + +Zoom options. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is |
+
tipLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the button tip. Default is |
+
keys |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Full keyboard access. |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is |
+
coordinateFormat |
+
+
+ + + +ol.CoordinateFormatType +| + +undefined + + + + | + + + + + +Coordinate + format. |
+
projection |
+
+
+ + + +ol.proj.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 |
+
minWidth |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum width in pixels. Default is |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
units |
+
+
+ + + +ol.control.ScaleLineUnits +| + +string +| + +undefined + + + + | + + + + + +Units.
+ Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Animation duration in milliseconds. Default is |
+
className |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +CSS class name. Default is |
+
zoomInLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the zoom-in button. Default is |
+
zoomOutLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the zoom-out button. Default is |
+
zoomInTipLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the button tip. Default is |
+
zoomOutTipLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the button tip. Default is |
+
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. Default is |
+
target |
+
+
+ + + +Element +| + +undefined + + + + | + + + + + +Target. |
+
tipLabel |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text label to use for the button tip. Default is |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The extent to zoom to. If + undefined the validity extent of the view projection is used. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
defaultProjection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Default projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
altitudeMode |
+
+
+ + + +ol.format.IGCZ +| + +undefined + + + + | + + + + + +Altitude mode.
+ Possible values are |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
defaultStyle |
+
+
+ + + +Array.<ol.style.Style> +| + +undefined + + + + | + + + + + +Default style. The default + default style is the same as Google Earth. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
defaultProjection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Default projection. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
featureNS |
+
+
+ + + +string + + + + | + + + + + +The namespace URI used for features. |
+
featureType |
+
+
+ + + +string + + + + | + + + + + +The feature type to parse. Only used for + read operations. |
+
schemaLocation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Optional schemaLocation to use + for serialization, this will override the default. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
featureNS |
+
+
+ + + +string + + + + | + + + + + +The namespace URI used for features. |
+
featurePrefix |
+
+
+ + + +string + + + + | + + + + + +The prefix for the feature namespace. |
+
featureTypes |
+
+
+ + + +Array.<string> + + + + | + + + + + +The feature type names. |
+
srsName |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +SRS name. No srsName attribute will be + set on geometries when this is not provided. |
+
handle |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Handle. |
+
outputFormat |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Output format. |
+
maxFeatures |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum number of features to fetch. |
+
geometryName |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Geometry name to use in a BBOX + filter. |
+
bbox |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent to use for the BBOX filter. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
featureNS |
+
+
+ + + +string + + + + | + + + + + +The namespace URI used for features. |
+
featurePrefix |
+
+
+ + + +string + + + + | + + + + + +The prefix for the feature namespace. |
+
featureType |
+
+
+ + + +string + + + + | + + + + + +The feature type name. |
+
srsName |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +SRS name. No srsName attribute will be + set on geometries when this is not provided. |
+
handle |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Handle. |
+
nativeElements |
+
+
+ + + +Array.<Object> + + + + | + + + + + +Native elements. Currently not + supported. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
html |
+
+
+ + + +string + + + + | + + + + + +HTML markup for this attribution. |
+
tileRanges |
+
+
+ + + +Object.<string, Array.<ol.TileRange>> +| + +undefined + + + + | + + + + + +Tile ranges (FOR INTERNAL USE ONLY). |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
loadTilesWhileAnimating |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +When set to false,
+ no tiles will be loaded while animating, which improves responsiveness
+ on devices with slow memory. Default is |
+
loadTilesWhileInteracting |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +When set to false,
+ no tiles will be loaded while interacting, which improves responsiveness
+ on devices with slow memory. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Start tracking. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +Array.<ol.Feature> +| + +ol.Collection +| + +undefined + + + + | + + + + + +Features. |
+
map |
+
+
+ + + +ol.Map +| + +undefined + + + + | + + + + + +Map. |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +Feature style. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
tracking |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Start Tracking. Default is |
+
trackingOptions |
+
+
+ + + +GeolocationPositionOptions +| + +undefined + + + + | + + + + + +Tracking options. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
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. |
+
deviceOptions |
+
+
+ + + +olx.DeviceOptions +| + +undefined + + + + | + + + + + +Device options for the map. |
+
pixelRatio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The ratio between physical
+ pixels and device-independent pixels (dips) on the device. If |
+
interactions |
+
+
+ + + +ol.Collection +| + +Array.<ol.interaction.Interaction> +| + +undefined + + + + | + + + + + +Interactions that are initially added to the map. |
+
keyboardEventTarget |
+
+
+ + + +Element +| + +Document +| + +string +| + +undefined + + + + | + + + + + +The element to listen to keyboard events on.
+ This determines when the |
+
layers |
+
+
+ + + +Array.<ol.layer.Base> +| + +ol.Collection +| + +undefined + + + + | + + + + + +Layers. |
+
ol3Logo |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Show ol3 logo. Default is |
+
overlays |
+
+
+ + + +ol.Collection +| + +Array.<ol.Overlay> +| + +undefined + + + + | + + + + + +Overlays initially added to the map. |
+
renderer |
+
+
+ + + +ol.RendererHint +| + +Array.<(ol.RendererHint|string)> +| + +string +| + +undefined + + + + | + + + + + +Renderer. |
+
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 +| + +string +| + +undefined + + + + | + + + + + +Positioning. |
+
stopEvent |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether event propagation to the map
+ viewport should be stopped. Default is |
+
insertFirst |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the overlay is inserted
+ first in the overlay container, or appended. Default is |
+
offsetX |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Horizontal offset in pixels.
+ A positive will shift the overlay right. Default is |
+
offsetY |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Vertical offset in pixels.
+ A positive will shift the overlay down. Default is |
+
Object literal with config options for the Proj4js projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
code |
+
+
+ + + +string + + + + | + + + + + +The SRS identifier code, e.g. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The validity extent for the SRS. |
+
global |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the projection is valid for the
+ whole globe. Default is |
+
Object literal with config options for the projection.
+| Name | + + +Type | + + + + + +Description | +
|---|---|---|
code |
+
+
+ + + +string + + + + | + + + + + +The SRS identifier code, e.g. |
+
units |
+
+
+ + + +ol.proj.Units +| + +string + + + + | + + + + + +Units. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The validity extent for the SRS. |
+
axisOrientation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The axis orientation as
+ specified in Proj4. The default is |
+
global |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the projection is valid for the
+ whole globe. Default is |
+
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 |
+
constrainRotation |
+
+
+ + + +boolean +| + +number +| + +undefined + + + + | + + + + + +Rotation constraint.
+ |
+
enableRotation |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Enable rotation. Default is
+ |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +The extent that constrains the center,
+ in other words, center cannot be set outside this extent.
+ Default is |
+
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.proj.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). Default is |
+
zoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Only used if |
+
zoomFactor |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The zoom factor used to determine the
+ resolution constraint. Used together with |
+
OpenLayers 3
+ Interactions for the map. Default is true for all options.
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
altShiftDragRotate |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether Alt-Shift-drag
+ rotate is desired. Default is |
+
doubleClickZoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether double click zoom is
+ desired. Default is |
+
keyboard |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether keyboard interaction is
+ desired. Default is |
+
mouseWheelZoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether mousewheel zoom is
+ desired. Default is |
+
shiftDragZoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether Shift-drag zoom is
+ desired. Default is |
+
dragPan |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether drag pan is
+ desired. Default is |
+
pinchRotate |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether pinch rotate is
+ desired. Default is |
+
pinchZoom |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether pinch zoom is
+ desired. Default is |
+
zoomDelta |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Zoom delta. |
+
zoomDuration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Zoom duration. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Animation duration in milliseconds. Default is |
+
delta |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The zoom delta applied on each double
+ click, default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
formatConstructors |
+
+
+ + + +Array.<function(new:ol.format.Feature)> +| + +undefined + + + + | + + + + + +Format constructors. |
+
reprojectTo |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Target projection. By + default, the map's view's projection is used. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is always. |
+
style |
+
+
+ + + +ol.style.Style + + + + | + + + + + +Style for the box. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
kinetic |
+
+
+ + + +ol.Kinetic +| + +undefined + + + + | + + + + + +Kinetic inertia to apply to the + pan. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is shify key. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is both shift and alt keys. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is shift key. |
+
style |
+
+
+ + + +ol.style.Style + + + + | + + + + + +Style for the box. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
features |
+
+
+ + + +ol.Collection +| + +undefined + + + + | + + + + + +Destination collection for the drawn features. |
+
source |
+
+
+ + + +ol.source.Vector +| + +undefined + + + + | + + + + + +Destination source for the drawn features. |
+
snapTolerance |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Pixel distance for snapping to the + drawing finish (default is 12). |
+
type |
+
+
+ + + +ol.geom.GeometryType + + + + | + + + + + +Drawing type ('Point', 'LineString', + 'Polygon', 'MultiPoint', 'MultiLineString', or 'MultiPolygon'). |
+
minPointsPerRing |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The number of points that must + be drawn before a polygon ring can be finished (default is 3). |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +Style for sketch features. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is no modifiers. |
+
pixelDelta |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Pixel The amount to pan on each key
+ press. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Animation duration in milliseconds. Default is |
+
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (i.e. Shift key) that determines if the interaction is active + or not, default is no modifiers. |
+
delta |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The amount to zoom on each key press. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
pixelTolerance |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Pixel tolerance for considering + the pointer close enough to a vertex for editing. Default is 20 pixels. |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +FeatureOverlay style. |
+
features |
+
+
+ + + +ol.Collection + + + + | + + + + + +The features the interaction works on. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Animation duration in milliseconds. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
threshold |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimal angle in radians to start a rotation.
+ Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
duration |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Animation duration in milliseconds. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
addCondition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (e.g. alt key) that determines if the feature is added to + the current selection. By default, this is never. Note that the default + toggle condition allows features to be added. |
+
condition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (e.g. shift key) that determines if the interaction is active + (i.e. selection occurs) or not. By default, a click with no modifier keys + toggles the selection. |
+
layerFilter |
+
+
+ + + +function + + + + | + + + + + +Filter + function to restrict selection to a subset of layers. |
+
layer |
+
+
+ + + +ol.layer.Layer +| + +undefined + + + + | + + + + + +Layer. The single layer from which + features should be selected. |
+
layers |
+
+
+ + + +Array.<ol.layer.Layer> +| + +undefined + + + + | + + + + + +Layers. Zero or more + layers from which features should be selected. |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +FeatureOverlay style. |
+
removeCondition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (e.g. alt key) that determines if the feature is removed from + the current selection. By default, this is never. |
+
toggleCondition |
+
+
+ + + +ol.events.ConditionType +| + +undefined + + + + | + + + + + +A conditional + modifier (e.g. shift key) that determines if the selection is toggled in + the current selection. By default, a shift-click toggles the feature in + the current selection. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. Default is |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. Default is |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. Default is |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity (0, 1). Default is |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. Default is |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The minimum resolution + (inclusive) at which this layer will be visible. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution + (exclusive) below which this layer will be visible. |
+
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. |
+
gradient |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +The color gradient of the heatmap,
+ specified as an array of CSS color strings. Default is |
+
radius |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Radius size in pixels. Default is |
+
blur |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Blur size in pixels. Default is |
+
shadow |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Shadow size in pixels. Default is |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The minimum resolution + (inclusive) at which this layer will be visible. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution + (exclusive) below which this layer will be visible. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. 0-1. Default is |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
source |
+
+
+ + + +ol.source.Vector + + + + | + + + + + +Source. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. Default is |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. Default is |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. Default is |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity (0, 1). Default is |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. Default is |
+
source |
+
+
+ + + +ol.source.Source + + + + | + + + + + +Source for this layer. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The minimum resolution + (inclusive) at which this layer will be visible. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution + (exclusive) below which this layer will be visible. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. Default is |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. Default is |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. Default is |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity (0, 1). Default is |
+
preload |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Preload. |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. Default is |
+
source |
+
+
+ + + +ol.source.Source + + + + | + + + + + +Source for this layer. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The minimum resolution + (inclusive) at which this layer will be visible. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution + (exclusive) below which this layer will be visible. |
+
useInterimTilesOnError |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Use interim tiles on
+ error. Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
brightness |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Brightness. |
+
contrast |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Contrast. |
+
hue |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Hue. |
+
minResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The minimum resolution + (inclusive) at which this layer will be visible. |
+
maxResolution |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The maximum resolution + (exclusive) below which this layer will be visible. |
+
opacity |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Opacity. 0-1. Default is |
+
saturation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Saturation. |
+
source |
+
+
+ + + +ol.source.Vector + + + + | + + + + + +Source. |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +Layer style. |
+
visible |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Visibility. Default is |
+
OpenLayers 3
+ OpenLayers 3
+ OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
culture |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Culture code. Default is |
+
key |
+
+
+ + + +string + + + + | + + + + + +Bing Maps API key. Get yours at + http://bingmapsportal.com/. |
+
imagerySet |
+
+
+ + + +string + + + + | + + + + + +Type of imagery. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
defaultProjection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Default projection. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
object |
+
+
+ + + +GeoJSONObject +| + +undefined + + + + | + + + + + +Object. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination projection. If + provided, features will be transformed to this projection. If not + provided, features will not be transformed. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
doc |
+
+
+ + + +Document +| + +undefined + + + + | + + + + + +Document. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
node |
+
+
+ + + +Node +| + +undefined + + + + | + + + + + +Node. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination projection. If + provided, features will be transformed to this projection. If not + provided, features will not be transformed. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
altitudeMode |
+
+
+ + + +ol.format.IGCZ +| + +undefined + + + + | + + + + + +Altitude mode.
+ Possible values are |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination projection. If + provided, features will be transformed to this projection. If not + provided, features will not be transformed. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
canvasFunction |
+
+
+ + + +ol.CanvasFunctionType + + + + | + + + + + +Canvas function. The function
+ returning the canvas element used by the source as an image. The arguments
+ passed to the function are: |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
ratio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Ratio. 1 means canvases are the size
+ of the map viewport, 2 means twice the size of the map viewport, and so
+ on. Default is |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions. If specified, + new canvases will be created for these resolutions only. |
+
state |
+
+
+ + + +ol.source.State +| + +string +| + +undefined + + + + | + + + + + +Source state. |
+
| 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. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
url |
+
+
+ + + +string + + + + | + + + + + +Url. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
ratio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Ratio. 1 means canvases are the size
+ of the map viewport, 2 means twice the size of the map viewport, and so
+ on. Default is |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions. If specified, + new canvases will be created for these resolutions only. |
+
source |
+
+
+ + + +ol.source.Vector + + + + | + + + + + +The vector source from which the vector + features drawn in canvas elements are read. |
+
style |
+
+
+ + + +ol.style.Style +| + +Array.<ol.style.Style> +| + +ol.feature.StyleFunction +| + +undefined + + + + | + + + + + +Style to use when rendering features to the canvas. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
hidpi |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Use the |
+
serverType |
+
+
+ + + +ol.source.wms.ServerType +| + +string +| + +undefined + + + + | + + + + + +The type of the remote WMS
+ server: |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
params |
+
+
+ + + +Object.<string, *> + + + + | + + + + + +WMS request parameters. At least a
+ |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
ratio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Ratio. |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions. If specified, + requests will be made for these resolutions only. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +WMS service URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
defaultStyle |
+
+
+ + + +Array.<ol.style.Style> +| + +undefined + + + + | + + + + + +Default style. |
+
doc |
+
+
+ + + +Document +| + +undefined + + + + | + + + + + +Document. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
node |
+
+
+ + + +Node +| + +undefined + + + + | + + + + + +Node. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination projection. If + provided, features will be transformed to this projection. If not + provided, features will not be transformed. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +The mapagent url. |
+
displayDpi |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The display resolution. Default is |
+
metersPerUnit |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The meters-per-unit value. Default is |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
hidpi |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Use the |
+
useOverlay |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +If |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
ratio |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Ratio. |
+
resolutions |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Resolutions. If specified, + requests will be made for these resolutions only. |
+
params |
+
+
+ + + +Object +| + +undefined + + + + | + + + + + +Additional parameters. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +string + + + + | + + + + + +Layer. Possible values are |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image
+ requests. Default is |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Max zoom. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL template. Must include |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
defaultStyle |
+
+
+ + + +Array.<ol.style.Style> +| + +undefined + + + + | + + + + + +Default style. |
+
doc |
+
+
+ + + +Document +| + +undefined + + + + | + + + + + +Document. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
{Node|undefined| |
+
+
+ + + | + + + + + +node Node. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
reprojectTo |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Re-project to. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
layer |
+
+
+ + + +string + + + + | + + + + + +Layer. |
+
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum zoom. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
opaque |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the layer is opaque. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL template. Must include |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.TileGrid +| + +undefined + + + + | + + + + + +Tile grid. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. Default is null. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
opaque |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether the layer is opaque. |
+
pixelRatios |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Pixel ratios supported by
+this source. Default is |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
tileClass |
+
+
+ + + +function +| + +undefined + + + + | + + + + + +Default is |
+
tileGrid |
+
+
+ + + +ol.tilegrid.TileGrid +| + +undefined + + + + | + + + + + +Tile grid. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
tileUrlFunction |
+
+
+ + + +ol.TileUrlFunctionType +| + +undefined + + + + | + + + + + +Function + to get tile URL given a tile coordinate and the projection. If not + provided, no tiles will be loaded. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
url |
+
+
+ + + +string + + + + | + + + + + +URL to the TileJSON file. |
+
| 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. |
+
gutter |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +The size in pixels of the
+ gutter around image tiles to ignore. By setting this property to a
+ non-zero value, images will be requested that are wider and taller than
+ the tile size by a value of |
+
hidpi |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Use the |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.TileGrid +| + +undefined + + + + | + + + + + +Tile grid. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
serverType |
+
+
+ + + +ol.source.wms.ServerType +| + +string +| + +undefined + + + + | + + + + + +The type of the remote WMS
+ server: |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
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. |
+
defaultProjection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Default projection. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
object |
+
+
+ + + +GeoJSONObject +| + +undefined + + + + | + + + + + +Object. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Destination projection. If + provided, features will be transformed to this projection. If not + provided, features will not be transformed. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
arrayBuffer |
+
+
+ + + +ArrayBuffer +| + +undefined + + + + | + + + + + +Array buffer. |
+
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
doc |
+
+
+ + + +Document +| + +undefined + + + + | + + + + + +Document. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
format |
+
+
+ + + +ol.format.Feature + + + + | + + + + + +Format. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
node |
+
+
+ + + +Node +| + +undefined + + + + | + + + + + +Node. |
+
object |
+
+
+ + + +Object +| + +undefined + + + + | + + + + + +Object. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +URLs. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
features |
+
+
+ + + +Array.<ol.Feature> +| + +undefined + + + + | + + + + + +Features. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
state |
+
+
+ + + +ol.source.State +| + +string +| + +undefined + + + + | + + + + + +State. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +string +| + +null +| + +undefined + + + + | + + + + + +crossOrigin setting for image + requests. |
+
extent |
+
+
+ + + +ol.Extent +| + +undefined + + + + | + + + + + +Extent. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
tileGrid |
+
+
+ + + +ol.tilegrid.WMTS + + + + | + + + + + +Tile grid. |
+
projection |
+
+
+ + + +ol.proj.ProjectionLike + + + + | + + + + + +Projection. |
+
requestEncoding |
+
+
+ + + +ol.source.WMTSRequestEncoding +| + +undefined + + + + | + + + + + +Request + encoding. |
+
layer |
+
+
+ + + +string + + + + | + + + + + +Layer. |
+
style |
+
+
+ + + +string + + + + | + + + + + +Style. |
+
version |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +WMTS version. Default to |
+
format |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Format. |
+
matrixSet |
+
+
+ + + +string + + + + | + + + + + +Matrix set. |
+
dimensions |
+
+
+ + + +Object +| + +undefined + + + + | + + + + + +Dimensions. |
+
url |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +URL. |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Maximum zoom. |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
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.proj.ProjectionLike + + + + | + + + + + +Projection. Default is |
+
maxZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Optional max zoom level. Default is |
+
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Unsupported (TODO: remove this). |
+
tileLoadFunction |
+
+
+ + + +ol.TileLoadFunctionType +| + +undefined + + + + | + + + + + +Optional + function to load a tile given a URL. |
+
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 |
+
urls |
+
+
+ + + +Array.<string> +| + +undefined + + + + | + + + + + +An array of URL templates. |
+
wrapX |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether to wrap the world horizontally.
+ Default is |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
attributions |
+
+
+ + + +Array.<ol.Attribution> +| + +undefined + + + + | + + + + + +Attributions. |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +Cross origin setting for image + requests. |
+
logo |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Logo. |
+
url |
+
+
+ + + +string + + + + | + + + + + +Prefix of URL template. |
+
tierSizeCalculation |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Tier size calculation method: |
+
size |
+
+
+ + + +ol.Size + + + + | + + + + + +Size of the image. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
fill |
+
+
+ + + +ol.style.Fill +| + +undefined + + + + | + + + + + +Fill style. |
+
radius |
+
+
+ + + +number + + + + | + + + + + +Circle radius. |
+
stroke |
+
+
+ + + +ol.style.Stroke +| + +undefined + + + + | + + + + + +Stroke style. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
color |
+
+
+ + + +ol.Color +| + +string +| + +undefined + + + + | + + + + + +Color. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
anchor |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Anchor. Default value is |
+
anchorOrigin |
+
+
+ + + +ol.style.IconAnchorOrigin +| + +undefined + + + + | + + + + + +Origin of the anchor: |
+
anchorXUnits |
+
+
+ + + +ol.style.IconAnchorUnits +| + +undefined + + + + | + + + + + +Units in which the anchor x value is specified.
+ A value of |
+
anchorYUnits |
+
+
+ + + +ol.style.IconAnchorUnits +| + +undefined + + + + | + + + + + +Units in which the anchor y value is specified.
+ A value of |
+
crossOrigin |
+
+
+ + + +null +| + +string +| + +undefined + + + + | + + + + + +crossOrigin setting for image. |
+
scale |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Scale. |
+
rotateWithView |
+
+
+ + + +boolean +| + +undefined + + + + | + + + + + +Whether to rotate the icon with the view. Default is |
+
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Rotation. |
+
size |
+
+
+ + + +ol.Size +| + +undefined + + + + | + + + + + +Icon size in pixel. |
+
src |
+
+
+ + + +string + + + + | + + + + + +Image source URI. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
color |
+
+
+ + + +ol.Color +| + +string +| + +undefined + + + + | + + + + + +Color. |
+
lineCap |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Line cap style: |
+
lineJoin |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Line join style: |
+
lineDash |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Line dash pattern. Default is |
+
miterLimit |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Miter limit. Default is |
+
width |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Width. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
fill |
+
+
+ + + +ol.style.Fill +| + +undefined + + + + | + + + + + +Fill style. |
+
image |
+
+
+ + + +ol.style.Image +| + +undefined + + + + | + + + + + +Image style. |
+
stroke |
+
+
+ + + +ol.style.Stroke +| + +undefined + + + + | + + + + + +Stroke style. |
+
text |
+
+
+ + + +ol.style.Text +| + +undefined + + + + | + + + + + +Text style. |
+
zIndex |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Z index. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
font |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Font. |
+
offsetX |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Horizontal text offset in pixels.
+ A positive will shift the text right. Default is |
+
offsetY |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Vertical text offset in pixels.
+ A positive will shift the text down. Default is |
+
scale |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Scale. |
+
rotation |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Rotation. |
+
text |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text. |
+
textAlign |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text alignment. |
+
textBaseline |
+
+
+ + + +string +| + +undefined + + + + | + + + + + +Text base line. |
+
fill |
+
+
+ + + +ol.style.Fill +| + +undefined + + + + | + + + + + +Fill style. |
+
stroke |
+
+
+ + + +ol.style.Stroke +| + +undefined + + + + | + + + + + +Stroke style. |
+
OpenLayers 3
+ | Name | + + +Type | + + + + + +Description | +
|---|---|---|
minZoom |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Minimum zoom. |
+
origin |
+
+
+ + + +ol.Coordinate +| + +undefined + + + + | + + + + + +Origin. |
+
origins |
+
+
+ + + +Array.<ol.Coordinate> +| + +undefined + + + + | + + + + + +Origins. |
+
resolutions |
+
+
+ + + +!Array.<number> + + + + | + + + + + +Resolutions. |
+
tileSize |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Tile size. |
+
tileSizes |
+
+
+ + + +Array.<number> +| + +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 |
+
+
+ + + +number +| + +undefined + + + + | + + + + + +Tile size. |
+
tileSizes |
+
+
+ + + +Array.<number> +| + +undefined + + + + | + + + + + +Tile sizes. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
maxZoom |
+
+
+ + + +number + + + + | + + + + + +Maximum zoom. |
+
| Name | + + +Type | + + + + + +Description | +
|---|---|---|
resolutions |
+
+
+ + + +!Array.<number> + + + + | + + + + + +Resolutions. |
+
goog.array.defaultCompare, which compares the elements
+ * using the built in < and > operators. This will produce the expected
+ * behavior for homogeneous arrays of String(s) and Number(s). The array
+ * specified must be sorted in ascending order (as defined by the
+ * comparison function). If the array is not sorted, results are undefined.
+ * If the array contains multiple instances of the specified target value, any
+ * of these instances may be found.
+ *
+ * Runtime: O(log n)
+ *
+ * @param {goog.array.ArrayLike} arr The array to be searched.
+ * @param {*} target The sought value.
+ * @param {Function=} opt_compareFn Optional comparison function by which the
+ * array is ordered. Should take 2 arguments to compare, and return a
+ * negative number, zero, or a positive number depending on whether the
+ * first argument is less than, equal to, or greater than the second.
+ * @return {number} Lowest index of the target value if found, otherwise
+ * (-(insertion point) - 1). The insertion point is where the value should
+ * be inserted into arr to preserve the sorted property. Return value >= 0
+ * iff target is found.
+ */
+goog.array.binarySearch = function(arr, target, opt_compareFn) {
+ return goog.array.binarySearch_(arr,
+ opt_compareFn || goog.array.defaultCompare, false /* isEvaluator */,
+ target);
+};
+
+
+/**
+ * Selects an index in the specified array using the binary search algorithm.
+ * The evaluator receives an element and determines whether the desired index
+ * is before, at, or after it. The evaluator must be consistent (formally,
+ * goog.array.map(goog.array.map(arr, evaluator, opt_obj), goog.math.sign)
+ * must be monotonically non-increasing).
+ *
+ * Runtime: O(log n)
+ *
+ * @param {goog.array.ArrayLike} arr The array to be searched.
+ * @param {Function} evaluator Evaluator function that receives 3 arguments
+ * (the element, the index and the array). Should return a negative number,
+ * zero, or a positive number depending on whether the desired index is
+ * before, at, or after the element passed to it.
+ * @param {Object=} opt_obj The object to be used as the value of 'this'
+ * within evaluator.
+ * @return {number} Index of the leftmost element matched by the evaluator, if
+ * such exists; otherwise (-(insertion point) - 1). The insertion point is
+ * the index of the first element for which the evaluator returns negative,
+ * or arr.length if no such element exists. The return value is non-negative
+ * iff a match is found.
+ */
+goog.array.binarySelect = function(arr, evaluator, opt_obj) {
+ return goog.array.binarySearch_(arr, evaluator, true /* isEvaluator */,
+ undefined /* opt_target */, opt_obj);
+};
+
+
+/**
+ * Implementation of a binary search algorithm which knows how to use both
+ * comparison functions and evaluators. If an evaluator is provided, will call
+ * the evaluator with the given optional data object, conforming to the
+ * interface defined in binarySelect. Otherwise, if a comparison function is
+ * provided, will call the comparison function against the given data object.
+ *
+ * This implementation purposefully does not use goog.bind or goog.partial for
+ * performance reasons.
+ *
+ * Runtime: O(log n)
+ *
+ * @param {goog.array.ArrayLike} arr The array to be searched.
+ * @param {Function} compareFn Either an evaluator or a comparison function,
+ * as defined by binarySearch and binarySelect above.
+ * @param {boolean} isEvaluator Whether the function is an evaluator or a
+ * comparison function.
+ * @param {*=} opt_target If the function is a comparison function, then this is
+ * the target to binary search for.
+ * @param {Object=} opt_selfObj If the function is an evaluator, this is an
+ * optional this object for the evaluator.
+ * @return {number} Lowest index of the target value if found, otherwise
+ * (-(insertion point) - 1). The insertion point is where the value should
+ * be inserted into arr to preserve the sorted property. Return value >= 0
+ * iff target is found.
+ * @private
+ */
+goog.array.binarySearch_ = function(arr, compareFn, isEvaluator, opt_target,
+ opt_selfObj) {
+ var left = 0; // inclusive
+ var right = arr.length; // exclusive
+ var found;
+ while (left < right) {
+ var middle = (left + right) >> 1;
+ var compareResult;
+ if (isEvaluator) {
+ compareResult = compareFn.call(opt_selfObj, arr[middle], middle, arr);
+ } else {
+ compareResult = compareFn(opt_target, arr[middle]);
+ }
+ if (compareResult > 0) {
+ left = middle + 1;
+ } else {
+ right = middle;
+ // We are looking for the lowest index so we can't return immediately.
+ found = !compareResult;
+ }
+ }
+ // left is the index if found, or the insertion point otherwise.
+ // ~left is a shorthand for -left - 1.
+ return found ? left : ~left;
+};
+
+
+/**
+ * Sorts the specified array into ascending order. If no opt_compareFn is
+ * specified, elements are compared using
+ * goog.array.defaultCompare, which compares the elements using
+ * the built in < and > operators. This will produce the expected behavior
+ * for homogeneous arrays of String(s) and Number(s), unlike the native sort,
+ * but will give unpredictable results for heterogenous lists of strings and
+ * numbers with different numbers of digits.
+ *
+ * This sort is not guaranteed to be stable.
+ *
+ * Runtime: Same as Array.prototype.sort
+ *
+ * @param {Array.