remove heading from getCurrentPosition

Author: ItsChaceD

CHANGELOG.md

@@ -2,8 +2,8 @@
 
 ### Features
 
-* **heading:** Added support for accurate heading information across all platforms.
-* **heading:** The `heading` property on iOS, Android, and Web now prioritizes actual compass bearing (true/magnetic heading) when available, falling back to direction of travel (course).
+* **heading:** Added support for accurate heading information across all platforms (available for `watchPosition` only).
+* **heading:** The `heading` property on iOS, Android, and Web now prioritizes actual compass bearing (true/magnetic heading) when available during active watches, falling back to direction of travel (course).
 * **coords:** Added `magneticHeading`, `trueHeading`, `headingAccuracy`, and `course` to `Position.coords`.
 * **web:** Improved heading support using `DeviceOrientation` APIs.
 

android/src/main/kotlin/com/capacitorjs/plugins/geolocation/GeolocationPlugin.kt

@@ -254,11 +254,11 @@ class GeolocationPlugin : Plugin() {
             put("altitude", locationResult.altitude)
             locationResult.altitudeAccuracy?.let { put("altitudeAccuracy", it) }
             put("speed", locationResult.speed)
-            put("heading", locationResult.heading)
-            locationResult.magneticHeading?.let { put("magneticHeading", it) }
-            locationResult.trueHeading?.let { put("trueHeading", it) }
-            locationResult.headingAccuracy?.let { put("headingAccuracy", it) }
-            locationResult.course?.let { put("course", it) }
+            put("heading", if (locationResult.heading != -1f) locationResult.heading else null)
+            put("magneticHeading", locationResult.magneticHeading)
+            put("trueHeading", locationResult.trueHeading)
+            put("headingAccuracy", locationResult.headingAccuracy)
+            put("course", locationResult.course)
         }
         return JSObject().apply {
             put("timestamp", locationResult.timestamp)

example-app/src/js/capacitor-welcome.js

@@ -207,13 +207,26 @@ window.customElements.define(
         }
         const timeRepresentation = location.timestamp ? new Date(location.timestamp).toISOString() : '-';
         stringRepresentation += `- Time: ${timeRepresentation}\n`;
-        stringRepresentation += `- Latitute: ${location?.coords.latitude}\n- Longitude: ${location?.coords.longitude}\n`;
-        if (location?.coords.altitude || location?.coords.heading || location?.coords.speed) {
-          stringRepresentation += `- Altitude: ${location?.coords.altitude}\n- Heading: ${location?.coords.heading}\n- Speed: ${location?.coords.speed}\n`;
-        }
+        stringRepresentation += `- Latitude: ${location?.coords.latitude}\n- Longitude: ${location?.coords.longitude}\n`;
         stringRepresentation += `- Accuracy: ${location?.coords.accuracy}\n`;
-        if (location?.coords.altitudeAccuracy) {
-          stringRepresentation += `- Altitude accuracy: ${location?.coords.altitudeAccuracy}\n`;
+        stringRepresentation += `- Altitude: ${location?.coords.altitude}\n`;
+        stringRepresentation += `- Altitude accuracy: ${location?.coords.altitudeAccuracy}\n`;
+        stringRepresentation += `- Speed: ${location?.coords.speed}\n`;
+
+        if (location?.coords.heading !== null && location?.coords.heading !== undefined && location?.coords.heading !== -1) {
+          stringRepresentation += `- Heading: ${location.coords.heading}\n`;
+        }
+        if (location?.coords.magneticHeading !== null && location?.coords.magneticHeading !== undefined && location?.coords.magneticHeading !== -1) {
+          stringRepresentation += `- Magnetic Heading: ${location.coords.magneticHeading}\n`;
+        }
+        if (location?.coords.trueHeading !== null && location?.coords.trueHeading !== undefined && location?.coords.trueHeading !== -1) {
+          stringRepresentation += `- True Heading: ${location.coords.trueHeading}\n`;
+        }
+        if (location?.coords.headingAccuracy !== null && location?.coords.headingAccuracy !== undefined && location?.coords.headingAccuracy !== -1) {
+          stringRepresentation += `- Heading Accuracy: ${location.coords.headingAccuracy}\n`;
+        }
+        if (location?.coords.course !== null && location?.coords.course !== undefined && location?.coords.course !== -1) {
+          stringRepresentation += `- Course: ${location.coords.course}\n`;
         }
         return stringRepresentation;
       }

src/definitions.ts

@@ -153,27 +153,35 @@ export interface Position {
     /**
      * The heading (measured in degrees) relative to magnetic north.
      *
+     * Only available when using `watchPosition`.
+     *
      * @since 8.1.0
      */
     magneticHeading: number | null | undefined;
 
     /**
      * The heading (measured in degrees) relative to true north.
      *
+     * Only available when using `watchPosition`.
+     *
      * @since 8.1.0
      */
     trueHeading: number | null | undefined;
 
     /**
      * The maximum deviation (measured in degrees) between the reported heading and the true geomagnetic heading.
      *
+     * Only available when using `watchPosition`.
+     *
      * @since 8.1.0
      */
     headingAccuracy: number | null | undefined;
 
     /**
      * The direction in which the device is travelling, measured in degrees and relative to due north.
      *
+     * Only available when using `watchPosition`.
+     *
      * @since 8.1.0
      */
     course: number | null | undefined;

src/web.ts

@@ -53,11 +53,11 @@ export class GeolocationWeb extends WebPlugin implements GeolocationPlugin {
     }
   }
 
-  private augmentPosition(pos: globalThis.GeolocationPosition): Position {
+  private augmentPosition(pos: globalThis.GeolocationPosition, isWatch = false): Position {
     const coords = pos.coords;
-    const orientation = this.latestOrientation;
+    const orientation = isWatch ? this.latestOrientation : null;
 
-    const heading = orientation?.trueHeading ?? orientation?.magneticHeading ?? coords.heading ?? null;
+    const heading = orientation?.trueHeading ?? orientation?.magneticHeading ?? (isWatch ? coords.heading : null) ?? null;
 
     return {
       timestamp: pos.timestamp,
@@ -72,7 +72,7 @@ export class GeolocationWeb extends WebPlugin implements GeolocationPlugin {
         magneticHeading: orientation?.magneticHeading ?? null,
         trueHeading: orientation?.trueHeading ?? null,
         headingAccuracy: orientation?.headingAccuracy ?? null,
-        course: coords.heading ?? null,
+        course: (isWatch ? coords.heading : null) ?? null,
       },
     };
   }
@@ -81,7 +81,7 @@ export class GeolocationWeb extends WebPlugin implements GeolocationPlugin {
     return new Promise((resolve, reject) => {
       navigator.geolocation.getCurrentPosition(
         pos => {
-          resolve(this.augmentPosition(pos));
+          resolve(this.augmentPosition(pos, false));
         },
         err => {
           reject(err);
@@ -99,7 +99,7 @@ export class GeolocationWeb extends WebPlugin implements GeolocationPlugin {
   async watchPosition(options: PositionOptions, callback: WatchPositionCallback): Promise<CallbackID> {
     const id = navigator.geolocation.watchPosition(
       pos => {
-        callback(this.augmentPosition(pos));
+        callback(this.augmentPosition(pos, true));
       },
       err => {
         callback(null, err);