- Overview
- Platform Support
- The Command-Line Interface
- Platform Guides
- Using Plugman to Manage Plugins
- The config.xml File
- Icons and Splash Screens
- Embedding WebViews
- Plugin Development Guide
- Privacy Guide
- Whitelist Guide
- Accelerometer
- Camera
- Capture
- Compass
- Connection
- Contacts
- Device
- Events
- File
- Geolocation
- Globalization
- InAppBrowser
- Media
- Notification
- Splashscreen
- Storage
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 needs the best possible results. By default, the device attempts to retrieve a
[Position](../Position/position.html)
using network-based methods. Setting this property totrue
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 executes. If the[geolocationSuccess](geolocationSuccess.html)
callback is not invoked within this time, the[geolocationError](geolocationError.html)
callback is passed a[PositionError](../PositionError/positionError.html).TIMEOUT
error code. (Note that when used in conjunction with[geolocation.watchPosition](../geolocation.watchPosition.html)
, the[geolocationError](geolocationError.html)
callback could be called on an interval everytimeout
milliseconds!) (Number) -
maximumAge: Accept a cached position whose age is no greater than the specified time in milliseconds. (Number)
Android Quirks
Android 2.x emulators do not return a geolocation result unless the enableHighAccuracy
option is set to true
.