OpenLayers 3 API Documentation - Class: ol.Geolocation

new Geolocation

Stability: experimental

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

Parameters:

Name Type Argument Description

options

olx.GeolocationOptions

Options.

Properties

Name	Type	Description
`tracking`	boolean \| undefined	Start Tracking. Default is `false`.
`trackingOptions`	GeolocationPositionOptions \| undefined	Tracking options.
`projection`	ol.proj.ProjectionLike	Projection.

Source:

geolocation.js, line 77

Fires:

ol.ObjectEvent ol.event:ObjectEvent

Extends

ol.Object

Observable Properties

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://www.w3.org/TR/geolocation-API/#position_options_interface

Methods

bindTo Stability: experimental

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

Parameters:

Name	Type	Argument	Description
`key`	string		Key name.
`target`	ol.Object		Target.
`targetKey`	string	<optional>	Target key.

Inherited From:

ol.Object#bindTo

Source:

object.js, line 247

Returns:

Type: ol.ObjectAccessor

dispatchChangeEvent Stability: experimental

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

Inherited From:

ol.Observable#dispatchChangeEvent

Source:

observable.js, line 39

Fires:

event:change

get Stability: experimental

Gets a value.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#get

Source:

object.js, line 304

Returns:

Value.

Type: *

getAccuracy Stability: experimental

Get the accuracy of the position in meters.

Source:

geolocation.js, line 213

Returns:

Position accuracy in meters.

Type: number | undefined

getAccuracyGeometry Stability: experimental

Get a geometry of the position accuracy.

Source:

geolocation.js, line 228

Returns:

Accuracy geometry.

Type: ol.geom.Geometry

getAltitude Stability: experimental

Get the altitude associated with the position.

Source:

geolocation.js, line 243

Returns:

The altitude in meters above the mean sea level.

Type: number | undefined

getAltitudeAccuracy Stability: experimental

Get the altitude accuracy of the position.

Source:

geolocation.js, line 258

Returns:

Altitude accuracy in meters.

Type: number | undefined

getHeading Stability: experimental

Get the heading as radians clockwise from North.

Source:

geolocation.js, line 273

Returns:

Heading.

Type: number | undefined

getKeys Stability: experimental

Get a list of object property names.

Inherited From:

ol.Object#getKeys

Source:

object.js, line 332

Returns:

List of property names.

Type: Array.<string>

getPosition Stability: experimental

Get the position of the device.

Source:

geolocation.js, line 288

Returns:

position.

Type: ol.Coordinate | undefined

getProjection Stability: experimental

Get the projection associated with the position.

Source:

geolocation.js, line 303

Returns:

projection.

Type: ol.proj.Projection | undefined

getProperties Stability: experimental

Get an object of all property names and values.

Inherited From:

ol.Object#getProperties

Source:

object.js, line 364

Returns:

Object.

Type: Object.<string, *>

getSpeed Stability: experimental

Get the speed in meters per second.

Source:

geolocation.js, line 318

Returns:

Speed.

Type: number | undefined

getTracking Stability: experimental

Are we tracking the user's position?

Source:

geolocation.js, line 333

Returns:

tracking.

Type: boolean

getTrackingOptions Stability: experimental

Get the tracking options.

Source:

geolocation.js, line 350

See:

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

Returns:

HTML 5 Gelocation tracking options.

Type: GeolocationPositionOptions | undefined

notify Stability: experimental

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.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#notify

Source:

object.js, line 384

on Stability: experimental

Listen for a certain type of event.

Parameters:

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 `this` in `listener`.

Inherited From:

ol.Observable#on

Source:

observable.js, line 61

Returns:

Unique key for the listener.

Type: goog.events.Key

once Stability: experimental

Listen once for a certain type of event.

Parameters:

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 `this` in `listener`.

Inherited From:

ol.Observable#once

Source:

observable.js, line 74

Returns:

Unique key for the listener.

Type: goog.events.Key

set Stability: experimental

Sets a value.

Parameters:

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

Inherited From:

ol.Object#set

Source:

object.js, line 415

setProjection Stability: experimental

Set the projection to use for transforming the coordinates.

Parameters:

Name	Type	Description
`projection`	ol.proj.Projection	Projection.

Source:

geolocation.js, line 365

setTracking Stability: experimental

Enable/disable tracking.

Parameters:

Name	Type	Description
`tracking`	boolean	Enable or disable tracking.

Source:

geolocation.js, line 379

setTrackingOptions Stability: experimental

Set the tracking options.

Parameters:

Name	Type	Description
`options`	GeolocationPositionOptions	HTML 5 Geolocation tracking options.

Source:

geolocation.js, line 395

See:

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

setValues Stability: experimental

Sets a collection of key-value pairs.

Parameters:

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

Inherited From:

ol.Object#setValues

Source:

object.js, line 444

un Stability: experimental

Unlisten for a certain type of event.

Parameters:

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 `this` in `listener`.