Skip to main content
Version: Next

lineOverlap

Description

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

Parameters

NameTypeDescription
line1Geometry | Feature<LineString | MultiLineString | Polygon | MultiPolygon>any LineString or Polygon
line2Geometry | Feature<LineString | MultiLineString | Polygon | MultiPolygon>any LineString or Polygon
options?ObjectOptional parameters (default {})
options.tolerance?numberTolerance distance to match overlapping line segments (in kilometers) (default 0)

Returns

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);

Installation

$ npm install @turf/line-overlap

import { lineOverlap } from "@turf/line-overlap";
const result = lineOverlap(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.lineOverlap(...);