Web/API/PositionOptions

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

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

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.

Specifications

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

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PositionOptions	Chrome Full support 5	Edge Full support 12	Firefox Full support 3.5	IE Full support 9	Opera Full support 16 Full support 16 No support 10 — 15	Safari Full support 5	WebView Android Full support Yes	Chrome Android Full support 18	Firefox Android Full support 4	Opera Android Full support 16 Full support 16 No support 10.1 — 14	Safari iOS Full support 5	Samsung Internet Android Full support 1.0
enableHighAccuracy	Chrome Full support 5	Edge Full support 12	Firefox Full support 3.5	IE Full support 9	Opera Full support 16 Full support 16 No support 10 — 15	Safari Full support 5	WebView Android Full support Yes	Chrome Android Full support 18	Firefox Android Full support 4	Opera Android Full support 16 Full support 16 No support 10.1 — 14	Safari iOS Full support Yes	Samsung Internet Android Full support 1.0
maximumAge	Chrome Full support 5	Edge Full support 12	Firefox Full support 3.5	IE Full support 9	Opera Full support 16 Full support 16 No support 10 — 15	Safari Full support 5	WebView Android Full support Yes	Chrome Android Full support 18	Firefox Android Full support 4	Opera Android Full support 16 Full support 16 No support 10.1 — 14	Safari iOS Full support Yes	Samsung Internet Android Full support 1.0
Secure context required	Chrome Full support 50	Edge Full support ≤79	Firefox Full support 55	IE No support No	Opera Full support 37	Safari Full support Yes	WebView Android Full support 51 Notes' Full support 51 Notes' Notes' Secure context is only required for applications targeting Android Nougat (7) and higher. See bug 603574.	Chrome Android Full support 50	Firefox Android Full support 55	Opera Android Full support 37	Safari iOS Full support Yes	Samsung Internet Android Full support 5.0
timeout	Chrome Full support 5	Edge Full support 12	Firefox Full support 3.5	IE Full support 9	Opera Full support 16 Full support 16 No support 10 — 15	Safari Full support 5	WebView Android Full support Yes	Chrome Android Full support 18	Firefox Android Full support 4	Opera Android Full support 16 Full support 16 No support 10.1 — 14	Safari iOS Full support Yes	Samsung Internet Android Full support 1.0

Legend

Full support  

Full support

No support  

No support

See implementation notes.'

See implementation notes.

See also

• Using the Geolocation API
• The Geolocation interface that uses it.

PositionOptions by Mozilla Contributors is licensed under CC-BY-SA 2.5.