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

The PositionOptions interface describes an object containing option properties to pass as a parameter of Geolocation.getCurrentPosition() and Geolocation.watchPosition().

Properties

The PositionOptions interface doesn't inherit any properties.

PositionOptions.enableHighAccuracy Secure context
Is a Boolean that indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false, the device can take the liberty to save resources by responding more quickly and/or using less power. Default: false.
PositionOptions.timeout Secure context
Is a positive long value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. The default value is Infinity, meaning that getCurrentPosition() won't return until the position is available.
PositionOptions.maximumAge Secure context
Is a positive long value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to Infinity the device must return a cached position regardless of its age. Default: 0.

Methods

The PositionOptions interface neither implements, nor inherits any method.

Specifications

Specification Status Comment
Geolocation API
The definition of 'PositionOptions' in that specification.
Recommendation Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support

47

5 — 471

Yes1

55

3.5 — 551

91

Yes

16 —?1

10 — 151

Yes

5 —?1

enableHighAccuracy5 Yes3.59

16

10 — 15

5
timeout5 Yes3.59

16

10 — 15

5
maximumAge5 Yes3.59

16

10 — 15

5
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support

47

5 — 471

47

5 — 471

Yes1

55

4 — 551

Yes

16 —?1

10 — 151

Yes ?
enableHighAccuracy55 Yes4

16

10 — 15

Yes ?
timeout55 Yes4

16

10 — 15

Yes ?
maximumAge55 Yes4

16

10 — 15

Yes ?

1. Secure context not required

See also

Document Tags and Contributors

Last updated by: connorshea,