New module @turf/line-intersect

Proposing to create a new core module @turf/line-intersect

Description: Takes two GeoJSON LineStrings and returns the intersecting point(s).

Future use: Need to use this functionality in @turf/polygon-slice.

Branch: line-intersect

Geometry Support

• LineString & MultiLineString & Polygon & MultiPolygon
• Geometry & Feature & FeatureCollection

Dependencies

• RBush (to quickly detect intersecting lines divided into pairs of 2 coordinates)
• @turf/helpers
• @turf/meta (using coordReduce & featureEach)
• @turf/bbox-polygon (debugging purposes)

Benchmark

double-intersect x 76,313 ops/sec ±0.86% (87 runs sampled)
feature-collection x 34,139 ops/sec ±1.80% (89 runs sampled)
multi-linestring x 23,185 ops/sec ±2.06% (84 runs sampled)
simple x 237,005 ops/sec ±1.41% (86 runs sampled)

JSDocs

/**
 * Takes two GeoJSON LineStrings and returns the intersecting point(s).
 *
 * @name lineIntersect
 * @param {Feature<LineString>} line1 GeoJSON LineString Feature
 * @param {Feature<LineString>} line2 GeoJSON LineString Feature
 * @returns {FeatureCollection<Point>} point(s) that intersect both lines
 * @example
 * var line1 = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "LineString",
 *     "coordinates": [
 *       [126, -11],
 *       [129, -21]
 *     ]
 *   }
 * };
 * var line2 = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "LineString",
 *     "coordinates": [
 *       [123, -18],
 *       [131, -14]
 *     ]
 *   }
 * };
 * var points = turf.lineIntersect(line1, line2);
 * //= points
 */
export default function (line1, line2) {

[mourner]

You’re on fire Denis, keep it up!

[DenisCarriere]

@shawnmgoulet Thanks for pointing this out, ~I believe we decided to drop the Polygon support since it would create a bit of confusion on how the Polygons are being handle.~

~Easy solution that you can do right now is use the @turf/polygon-to-linestring module which will do exactly what the name of the module will do.~

~Note: Handling Multi-Polygons with holes will return a FeatureCollection of MultiLineStrings.~

Edit: @turf/line-intersect does work with Polygons & Multi-Polygons.