new ol.Geolocation(opt_options)
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Fires:
-
change
- Triggered when the position changes. -
change:accuracy
(ol.ObjectEvent) -
change:accuracyGeometry
(ol.ObjectEvent) -
change:altitude
(ol.ObjectEvent) -
change:altitudeAccuracy
(ol.ObjectEvent) -
change:heading
(ol.ObjectEvent) -
change:position
(ol.ObjectEvent) -
change:projection
(ol.ObjectEvent) -
change:speed
(ol.ObjectEvent) -
change:tracking
(ol.ObjectEvent) -
change:trackingOptions
(ol.ObjectEvent)
Extends
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
-
getAccuracy(){number|undefined}
src/ol/geolocation.js, line 198 -
Get the accuracy of the position in meters.
Returns:
The accuracy of the position measurement in meters.
-
getAccuracyGeometry(){ol.geom.Geometry}
src/ol/geolocation.js, line 214 -
Get a geometry of the position accuracy.
Returns:
A geometry of the position accuracy.
-
getAltitude(){number|undefined}
src/ol/geolocation.js, line 231 -
Get the altitude associated with the position.
Returns:
The altitude of the position in meters above mean sea level.
-
getAltitudeAccuracy(){number|undefined}
src/ol/geolocation.js, line 248 -
Get the altitude accuracy of the position.
Returns:
The accuracy of the altitude measurement in meters.
-
getHeading(){number|undefined}
src/ol/geolocation.js, line 264 -
Get the heading as radians clockwise from North.
Returns:
The heading of the device in radians from north.
-
getPosition(){ol.Coordinate|undefined}
src/ol/geolocation.js, line 281 -
Get the position of the device.
Returns:
The current position of the device reported in the current projection.
-
getProjection(){ol.proj.Projection|undefined}
src/ol/geolocation.js, line 298 -
Get the projection associated with the position.
Returns:
The projection the position is reported in.
-
getSpeed(){number|undefined}
src/ol/geolocation.js, line 315 -
Get the speed in meters per second.
Returns:
The instantaneous speed of the device in meters per second.
-
getTracking(){boolean}
src/ol/geolocation.js, line 331 -
Are we tracking the user's position?
Returns:
Whether to track the device's position.
-
getTrackingOptions(){GeolocationPositionOptions|undefined}
src/ol/geolocation.js, line 350 -
Get the tracking options.
Returns:
PositionOptions as defined by the HTML5 Geolocation spec at http://www.w3.org/TR/geolocation-API/#position_options_interface
-
on(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 75 -
Listen for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
once(type, listener, opt_this){goog.events.Key} inherited
src/ol/observable.js, line 88 -
Listen once for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object to use as
this
inlistener
.Returns:
Unique key for the listener.
-
setProjection(projection)
src/ol/geolocation.js, line 367 -
Set the projection to use for transforming the coordinates.
Name Type Description projection
ol.proj.Projection The projection the position is reported in.
-
setTracking(tracking)
src/ol/geolocation.js, line 382 -
Enable/disable tracking.
Name Type Description tracking
boolean Whether to track the device's position.
-
setTrackingOptions(options)
src/ol/geolocation.js, line 400 -
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
-
un(type, listener, opt_this) inherited
src/ol/observable.js, line 101 -
Unlisten for a certain type of event.
Name Type Description type
string | Array.<string> The event type or array of event types.
listener
function The listener function.
this
Object The object which was used as
this
by thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
.