@turf/line-overlap

lineOverlap

Takes any LineString or Polygon and returns the overlapping lines between both features.

Parameters

• line1 (Geometry | Feature<(LineString | MultiLineString | Polygon | MultiPolygon)>) any LineString or Polygon

• line2 (Geometry | Feature<(LineString | MultiLineString | Polygon | MultiPolygon)>) any LineString or Polygon

• options Object Optional parameters (optional, default {})

  • options.tolerance number Tolerance distance to match overlapping line segments (in kilometers) (optional, default 0)

Examples

var line1 = turf.lineString([[115, -35], [125, -30], [135, -30], [145, -35]]);
var line2 = turf.lineString([[115, -25], [125, -30], [135, -30], [145, -25]]);

var overlapping = turf.lineOverlap(line1, line2);

//addToMap
var addToMap = [line1, line2, overlapping]

Returns FeatureCollection<LineString> lines(s) that are overlapping between both features

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this single module individually:

$ npm install @turf/line-overlap

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf