GeolocationCoordinates: toJSON() method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("Geolocation API")}}

The **toJSON()** method of the {{domxref("GeolocationCoordinates")}} interface returns a JSON-serializable plain object representing the GeolocationCoordinates object.

The method is automatically called by {{jsxref("JSON.stringify()")}} when a GeolocationCoordinates object is encountered during JSON serialization.

Syntax

js-nolint
toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • {{domxref("GeolocationCoordinates/accuracy", "accuracy")}}
  • {{domxref("GeolocationCoordinates/latitude", "latitude")}}
  • {{domxref("GeolocationCoordinates/longitude", "longitude")}}
  • {{domxref("GeolocationCoordinates/altitude", "altitude")}}
  • {{domxref("GeolocationCoordinates/altitudeAccuracy", "altitudeAccuracy")}}
  • {{domxref("GeolocationCoordinates/heading", "heading")}}
  • {{domxref("GeolocationCoordinates/speed", "speed")}}

Each property's value is copied as-is.

Examples

Calling toJSON() directly

This example obtains a GeolocationCoordinates object. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.

js
navigator.geolocation.getCurrentPosition((position) => {
  const coords = position.coords;

  const json = coords.toJSON();
  console.log(json); // A plain object
  console.log(typeof json); // "object"
  console.log(json.latitude); // Same value as coords.latitude
});

Serializing to a JSON string

Within the callback from the previous example, the same object can be serialized using {{jsxref("JSON.stringify()")}}, which calls the toJSON() method automatically.

js
console.log(JSON.stringify(coords));

This would log a JSON string like so (formatted for readability):

json
{
  "accuracy": 12.5,
  "latitude": 53.125,
  "longitude": 8.75,
  "altitude": null,
  "altitudeAccuracy": null,
  "heading": null,
  "speed": null
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{jsxref("JSON")}}