This plugin provides information about the device's location, such as latitude and longitude. Source of location information is Global Positioning System (GPS). There is no guarantee that the API returns the device's actual location.
This API is based on the W3C Geolocation API Specification, and use the Android GPS provider.
WARNING: Collection and use of geolocation data raises important privacy issues. Your app's privacy policy should discuss how the app uses geolocation data, whether it is shared with any other parties, and the level of precision of the data (for example, coarse, fine, ZIP code level, etc.). Geolocation data is generally considered sensitive because it can reveal user's whereabouts and, if stored, the history of their travels. Therefore, in addition to the app's privacy policy, you should strongly consider providing a just-in-time notice before the app accesses geolocation data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for OK and No Thanks). For more information, please see the Privacy Guide.
The plugin is published on npm:
cordova plugin add cordova-plugin-gpslocationIf you wish to use the old Cordova registry, use the previous plugin id:
cordova plugin add fr.louisbl.cordova.gpslocationReturns the device's current position to the geolocationSuccess
callback with a Position object as the parameter. If there is an
error, the geolocationError callback is passed a
PositionError object.
GPSLocation.getCurrentPosition(geolocationSuccess,
[geolocationError],
[geolocationOptions]);geolocationSuccess: The callback that is passed the current position.
geolocationError: (Optional) The callback that executes if an error occurs.
geolocationOptions: (Optional) The geolocation options.
// onSuccess Callback
// This method accepts a Position object, which contains the
// current GPS coordinates
//
var onSuccess = function(position) {
alert('Latitude: ' + position.coords.latitude + '\n' +
'Longitude: ' + position.coords.longitude + '\n' +
'Altitude: ' + position.coords.altitude + '\n' +
'Accuracy: ' + position.coords.accuracy + '\n' +
'Altitude Accuracy: ' + position.coords.altitudeAccuracy + '\n' +
'Heading: ' + position.coords.heading + '\n' +
'Speed: ' + position.coords.speed + '\n' +
'Timestamp: ' + position.timestamp + '\n');
};
// onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
GPSLocation.getCurrentPosition(onSuccess, onError);Returns the device's current position when a change in position is detected.
When the device retrieves a new location, the geolocationSuccess
callback executes with a Position object as the parameter. If
there is an error, the geolocationError callback executes with a
PositionError object as the parameter.
var watchId = GPSLocation.watchPosition(geolocationSuccess,
[geolocationError],
[geolocationOptions]);geolocationSuccess: The callback that is passed the current position.
geolocationError: (Optional) The callback that executes if an error occurs.
geolocationOptions: (Optional) The geolocation options.
GPSLocation.clearWatch to stop watching for changes in position.// onSuccess Callback
// This method accepts a `Position` object, which contains
// the current GPS coordinates
//
function onSuccess(position) {
var element = document.getElementById('geolocation');
element.innerHTML = 'Latitude: ' + position.coords.latitude + '<br />' +
'Longitude: ' + position.coords.longitude + '<br />' +
'<hr />' + element.innerHTML;
}
// onError Callback receives a PositionError object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
}
// Options: throw an error if no update is received every 30 seconds.
//
var watchID = GPSLocation.watchPosition(onSuccess, onError, { timeout: 30000 });Optional parameters to customize the retrieval of the geolocation
Position.
{ maximumAge: 3000, timeout: 5000 };timeout: The maximum length of time (milliseconds) that is allowed to pass from the call to GPSLocation.getCurrentPosition or geolocation.watchPosition until the corresponding geolocationSuccess callback executes. If the geolocationSuccess callback is not invoked within this time, the geolocationError callback is passed a PositionError.TIMEOUT error code. (Note that when used in conjunction with geolocation.watchPosition, the geolocationError callback could be called on an interval every timeout milliseconds!) (Number)
maximumAge: Accept a cached position whose age is no greater than the specified time in milliseconds. (Number)
Stop watching for changes to the device's location referenced by the
watchID parameter.
GPSLocation.clearWatch(watchID);watchPosition interval to clear. (String)// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
//
var watchID = GPSLocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
// ...later on...
GPSLocation.clearWatch(watchID);Contains Position coordinates and timestamp, created by the geolocation API.
coords: A set of geographic coordinates. (Coordinates)
timestamp: Creation timestamp for coords. (Date)
A Coordinates object is attached to a Position object that is
available to callback functions in requests for the current position.
It contains a set of properties that describe the geographic coordinates of a position.
latitude: Latitude in decimal degrees. (Number)
longitude: Longitude in decimal degrees. (Number)
altitude: Height of the position in meters above the ellipsoid. (Number)
accuracy: Accuracy level of the latitude and longitude coordinates in meters. (Number)
altitudeAccuracy: Accuracy level of the altitude coordinate in meters. (Number)
heading: Direction of travel, specified in degrees counting clockwise relative to the true north. (Number)
speed: Current ground speed of the device, specified in meters per second. (Number)
altitudeAccuracy: Not supported by Android devices, returning null.
The PositionError object is passed to the geolocationError
callback function when an error occurs with GPSLocation.
code: One of the predefined error codes listed below.
message: Error message describing the details of the error encountered.
PositionError.PERMISSION_DENIED
PositionError.POSITION_UNAVAILABLE
PositionError.TIMEOUT
timeout included in geolocationOptions. When used with GPSLocation.watchPosition, this error could be repeatedly passed to the geolocationError callback every timeout milliseconds.