@turf/line-intersect
TypeScript icon, indicating that this package has built-in type declarations

7.0.0 • Public • Published

@turf/line-intersect

lineIntersect

Takes any LineString or Polygon GeoJSON and returns the intersecting point(s).

Parameters

  • line1 GeoJSON any LineString or Polygon

  • line2 GeoJSON any LineString or Polygon

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

    • options.removeDuplicates boolean remove duplicate intersections (optional, default true)
    • options.ignoreSelfIntersections boolean ignores self-intersections on input features (optional, default false)

Examples

var line1 = turf.lineString([[126, -11], [129, -21]]);
var line2 = turf.lineString([[123, -18], [131, -14]]);
var intersects = turf.lineIntersect(line1, line2);

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

Returns FeatureCollection<Point> point(s) that intersect both


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-intersect

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/line-intersect

Weekly Downloads

594,392

Version

7.0.0

License

MIT

Unpacked Size

20.7 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly