Have ideas to improve npm?Join in the discussion! »

@turf/intersectTypeScript icon, indicating that this package has built-in type declarations

6.3.0 • Public • Published

@turf/intersect

intersect

Takes two polygon or multi-polygon geometries and finds their polygonal intersection. If they don't intersect, returns null.

Parameters

Examples

var poly1 = turf.polygon([[
  [-122.801742, 45.48565],
  [-122.801742, 45.60491],
  [-122.584762, 45.60491],
  [-122.584762, 45.48565],
  [-122.801742, 45.48565]
]]);

var poly2 = turf.polygon([[
  [-122.520217, 45.535693],
  [-122.64038, 45.553967],
  [-122.720031, 45.526554],
  [-122.669906, 45.507309],
  [-122.723464, 45.446643],
  [-122.532577, 45.408574],
  [-122.487258, 45.477466],
  [-122.520217, 45.535693]
]]);

var intersection = turf.intersect(poly1, poly2);

//addToMap
var addToMap = [poly1, poly2, intersection];

Returns (Feature | null) returns a feature representing the area they share (either a Polygon or MultiPolygon). If they do not share any area, returns null.


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 module individually:

$ npm install @turf/intersect

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Install

npm i @turf/intersect

DownloadsWeekly Downloads

135,063

Version

6.3.0

License

MIT

Unpacked Size

10.9 kB

Total Files

7

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar