Compute multiFeatureLocation in addition to location property in @turf/nearest-point-on-line

Fix unit tests

Author: EmilJunker

packages/turf-nearest-point-on-line/index.ts

@@ -22,7 +22,7 @@ import { getCoord, getCoords } from "@turf/invariant";
  * @param {Geometry|Feature<Point>|number[]} pt point to snap from
  * @param {Object} [options={}] Optional parameters
  * @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}
- * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain four values: `index`: closest point was found on nth line part, `multiFeatureIndex`: closest point was found on the nth line of the `MultiLineString`, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point.
+ * @returns {Feature<Point>} closest point on the `line` to `point`. The properties object will contain four values: `index`: closest point was found on nth line part, `multiFeatureIndex`: closest point was found on the nth line of the `MultiLineString`, `dist`: distance between pt and the closest point, `location`: distance along the line between start and the closest point, `multiFeatureLocation`: distance along the line between start of the `MultiLineString` where closest point was found and the closest point.
  * @example
  * var line = turf.lineString([
  *     [-77.031669, 38.878605],
@@ -51,6 +51,7 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
     index: number;
     multiFeatureIndex: number;
     location: number;
+    multiFeatureLocation: number;
     [key: string]: any;
   }
 > {
@@ -62,18 +63,33 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
 
   let closestPt: Feature<
     Point,
-    { dist: number; index: number; multiFeatureIndex: number; location: number }
+    {
+      dist: number;
+      index: number;
+      multiFeatureIndex: number;
+      location: number;
+      multiFeatureLocation: number;
+    }
   > = point([Infinity, Infinity], {
     dist: Infinity,
     index: -1,
     multiFeatureIndex: -1,
     location: -1,
+    multiFeatureLocation: -1,
   });
 
   let length = 0.0;
+  let multiFeatureLength = 0.0;
+  let currentMultiFeatureIndex = -1;
   flattenEach(
     lines,
     function (line: any, _featureIndex: number, multiFeatureIndex: number) {
+      //reset multiFeatureLength at each changed multiFeatureIndex
+      if (currentMultiFeatureIndex !== multiFeatureIndex) {
+        currentMultiFeatureIndex = multiFeatureIndex;
+        multiFeatureLength = 0.0;
+      }
+
       const coords: any = getCoords(line);
 
       for (let i = 0; i < coords.length - 1; i++) {
@@ -106,10 +122,12 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
           );
         }
 
+        const lineLocationDist = distance(start, intersectPos, options);
         const intersectPt = point(intersectPos, {
           dist: distance(pt, intersectPos, options),
           multiFeatureIndex: multiFeatureIndex,
-          location: length + distance(start, intersectPos, options),
+          location: length + lineLocationDist,
+          multiFeatureLocation: multiFeatureLength + lineLocationDist,
         });
 
         if (intersectPt.properties.dist < closestPt.properties.dist) {
@@ -124,8 +142,9 @@ function nearestPointOnLine<G extends LineString | MultiLineString>(
           };
         }
 
-        // update length
+        // update length and multiFeatureLength
         length += sectionLength;
+        multiFeatureLength += sectionLength;
       }
     }
   );

packages/turf-nearest-point-on-line/test.ts

@@ -40,6 +40,10 @@ test("turf-nearest-point-on-line", (t) => {
     onLine.properties["marker-color"] = "#F0F";
     onLine.properties.dist = round(onLine.properties.dist, 6);
     onLine.properties.location = round(onLine.properties.location, 6);
+    onLine.properties.multiFeatureLocation = round(
+      onLine.properties.multiFeatureLocation,
+      6
+    );
     const between = lineString(
       [onLine.geometry.coordinates, point.geometry.coordinates],
       { stroke: "#F00", "stroke-width": 6 }
@@ -399,6 +403,37 @@ test("turf-nearest-point-on-line -- multifeature index", (t) => {
   t.end();
 });
 
+test("turf-nearest-point-on-line -- issue 2753 multifeature location", (t) => {
+  const multiLine = multiLineString([
+    [
+      [-122.3125, 47.6632],
+      [-122.3102, 47.6646],
+    ],
+    [
+      [-122.3116, 47.6623],
+      [-122.3091, 47.6636],
+    ],
+  ]);
+
+  const ptA = point([-122.3106, 47.6638], { name: "A" });
+  const ptB = point([-122.3102, 47.6634], { name: "B" });
+
+  const nearestToA = nearestPointOnLine(multiLine, ptA, { units: "meters" });
+  const nearestToB = nearestPointOnLine(multiLine, ptB, { units: "meters" });
+
+  t.equal(
+    Number(nearestToA.properties.multiFeatureLocation.toFixed(6)),
+    150.296465,
+    "nearestToA multiFeatureLocation"
+  );
+  t.equal(
+    Number(nearestToB.properties.multiFeatureLocation.toFixed(6)),
+    157.738215,
+    "nearestToB multiFeatureLocation"
+  );
+  t.end();
+});
+
 test("turf-nearest-point-on-line -- issue 1514", (t) => {
   const pt = point([-40.01, 56]);
   const line = lineString([

packages/turf-nearest-point-on-line/test/out/line-northern-latitude-#344.geojson

@@ -42,6 +42,7 @@
         "dist": 5.959562,
         "multiFeatureIndex": 0,
         "location": 19.748879,
+        "multiFeatureLocation": 19.748879,
         "index": 1,
         "marker-color": "#F0F"
       },

packages/turf-nearest-point-on-line/test/out/line1.geojson

@@ -42,6 +42,7 @@
         "dist": 2.556271,
         "multiFeatureIndex": 0,
         "location": 22.137494,
+        "multiFeatureLocation": 22.137494,
         "index": 1,
         "marker-color": "#F0F"
       },

packages/turf-nearest-point-on-line/test/out/multiLine1.geojson

@@ -71,6 +71,7 @@
         "index": 21,
         "multiFeatureIndex": 1,
         "location": 9479.011715,
+        "multiFeatureLocation": 4800.716022,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/multiLine2.geojson

@@ -52,6 +52,7 @@
         "index": 0,
         "multiFeatureIndex": 1,
         "location": 1656.139708,
+        "multiFeatureLocation": 0,
         "marker-color": "#F0F"
       },
       "geometry": {

packages/turf-nearest-point-on-line/test/out/multiLine3.geojson

@@ -60,6 +60,7 @@
         "dist": 121.937841,
         "multiFeatureIndex": 0,
         "location": 214.735285,
+        "multiFeatureLocation": 214.735285,
         "index": 0,
         "marker-color": "#F0F"
       },

packages/turf-nearest-point-on-line/test/out/route1.geojson

@@ -4795,6 +4795,7 @@
         "dist": 7.876557,
         "multiFeatureIndex": 0,
         "location": 183.46844,
+        "multiFeatureLocation": 183.46844,
         "index": 3104,
         "marker-color": "#F0F"
       },

packages/turf-nearest-point-on-line/test/out/route2.geojson

@@ -3799,6 +3799,7 @@
         "dist": 19.22738,
         "multiFeatureIndex": 0,
         "location": 303.639629,
+        "multiFeatureLocation": 303.639629,
         "index": 1185,
         "marker-color": "#F0F"
       },