Class: Geolocation

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());
});

Extends

• ol.Object

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
accuracy	number | undefined	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 | undefined	no	change:altitude	The altitude of the position in meters above mean sea level.
altitudeAccuracy	number | undefined	no	change:altitudeaccuracy	The accuracy of the altitude measurement in meters.
heading	number | undefined	no	change:heading	The heading of the device in radians from north.
position	ol.Coordinate | undefined	no	change:position	The current position of the device reported in the current projection.
projection	ol.proj.Projection | undefined	yes	change:projection	The projection the position is reported in.
speed	number | undefined	no	change:speed	The instantaneous speed of the device in meters per second.
tracking	boolean	yes	change:tracking	Whether to track the device's position.
trackingOptions	GeolocationPositionOptions | undefined	yes	change:trackingoptions	PositionOptions as defined by the HTML5 Geolocation spec at http://www.w3.org/TR/geolocation-API/#position_options_interface

Methods

experimental inherited bindTo(key, target, opt_targetKey){ol.ObjectAccessor}

src/ol/object.js, line 247

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>	optional Target key.

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:

• change

experimental inherited get(key){*}

src/ol/object.js, line 304

Gets a value.

Name	Type	Description
key	string	Key name.

experimental getAccuracy(){number|undefined}

src/ol/geolocation.js, line 193

Get the accuracy of the position in meters.

Returns:

accuracy of the position measurement in meters.

experimental getAccuracyGeometry(){ol.geom.Geometry}

src/ol/geolocation.js, line 209

Get a geometry of the position accuracy.

Returns:

geometry of the position accuracy.

experimental getAltitude(){number|undefined}

src/ol/geolocation.js, line 226

Get the altitude associated with the position.

Returns:

altitude of the position in meters above mean sea level.

experimental getAltitudeAccuracy(){number|undefined}

src/ol/geolocation.js, line 243

Get the altitude accuracy of the position.

Returns:

accuracy of the altitude measurement in meters.

experimental getHeading(){number|undefined}

src/ol/geolocation.js, line 259

Get the heading as radians clockwise from North.

Returns:

heading of the device in radians from north.

experimental inherited getKeys(){Array.<string>}

src/ol/object.js, line 332

Get a list of object property names.

Returns:

of property names.

experimental getPosition(){ol.Coordinate|undefined}

src/ol/geolocation.js, line 276

Get the position of the device.

Returns:

current position of the device reported in the current projection.

experimental getProjection(){ol.proj.Projection|undefined}

src/ol/geolocation.js, line 293

Get the projection associated with the position.

Returns:

projection the position is reported in.

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

src/ol/object.js, line 364

Get an object of all property names and values.

experimental getSpeed(){number|undefined}

src/ol/geolocation.js, line 310

Get the speed in meters per second.

Returns:

instantaneous speed of the device in meters per second.

experimental getTracking(){boolean}

src/ol/geolocation.js, line 326

Are we tracking the user's position?

Returns:

to track the device's position.

experimental getTrackingOptions(){GeolocationPositionOptions|undefined}

src/ol/geolocation.js, line 345

Get the tracking options.

See:

• http://www.w3.org/TR/geolocation-API/#position-options

Returns:

as defined by the HTML5 Geolocation spec at http://www.w3.org/TR/geolocation-API/#position_options_interface

experimental inherited notify(key)

src/ol/object.js, line 384

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.

experimental inherited on(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 61

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>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

src/ol/observable.js, line 74

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>	optional The object to use as this in listener.

Returns:

key for the listener.

experimental inherited set(key, value)

src/ol/object.js, line 415

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

experimental setProjection(projection)

src/ol/geolocation.js, line 362

Set the projection to use for transforming the coordinates.

Name	Type	Description
projection	ol.proj.Projection	The projection the position is reported in.

experimental setTracking(tracking)

src/ol/geolocation.js, line 377

Enable/disable tracking.

Name	Type	Description
tracking	boolean	Whether to track the device's position.

experimental setTrackingOptions(options)

src/ol/geolocation.js, line 395

Set the tracking options.

Name	Type	Description
options	GeolocationPositionOptions	PositionOptions as defined by the HTML5 Geolocation spec at http://www.w3.org/TR/geolocation-API/#position_options_interface

See:

• http://www.w3.org/TR/geolocation-API/#position-options

experimental inherited setValues(values)

src/ol/object.js, line 444

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

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>	optional The object to use as this in listener.

experimental inherited unbind(key)

src/ol/object.js, line 458

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.

experimental inherited unbindAll()

src/ol/object.js, line 482

Removes all bindings.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

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

Name	Type	Description
key	goog.events.Key	Key.