geolocationOptions

Optional parameters to customize the retrieval of the geolocation [Position](../Position/position.html).

{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };

Options

  • enableHighAccuracy: Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a [Position](../Position/position.html) using network-based methods. Setting this property to true tells the framework to use more accurate methods, such as satellite positioning. (Boolean)
  • timeout: The maximum length of time (milliseconds) that is allowed to pass from the call to [geolocation.getCurrentPosition](../geolocation.getCurrentPosition.html) or [geolocation.watchPosition](../geolocation.watchPosition.html) until the corresponding [geolocationSuccess](geolocationSuccess.html) callback is invoked. If the [geolocationSuccess](geolocationSuccess.html) callback is not invoked within this time, the [geolocationError](geolocationError.html) callback will be invoked with a [PositionError](../PositionError/positionError.html).TIMEOUT error code. NOTE: when used in conjunction with [geolocation.watchPosition](../geolocation.watchPosition.html), the [geolocationError](geolocationError.html) 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)

Android Quirks

The Android 2.x simulators will not return a geolocation result unless the enableHighAccuracy option is set to true.

{ enableHighAccuracy: true }