Geolocation.clearWatch()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The Geolocation.clearWatch() method is used to unregister location/error monitoring handlers previously installed using Geolocation.watchPosition().

Syntax

navigator.geolocation.clearWatch(id);

Parameters

id

The ID number returned by the Geolocation.watchPosition() method when installing the handler you wish to remove.

Example

var id, target, option;

function success(pos) {
  var crd = pos.coords;

  if (target.latitude === crd.latitude && target.longitude === crd.longitude) {
    console.log('Congratulations, you\'ve reached the target!');
    navigator.geolocation.clearWatch(id);
  }
};

function error(err) {
  console.warn('ERROR(' + err.code + '): ' + err.message);
};

target = {
  latitude : 0,
  longitude: 0,
}

options = {
  enableHighAccuracy: false,
  timeout: 5000,
  maximumAge: 0
};

id = navigator.geolocation.watchPosition(success, error, options);

Specifications

Specification
Geolocation API
# clearwatch-method

Browser compatibility

BCD tables only load in the browser

See also