@turf/intersect
Advanced tools
Comparing version 3.3.3 to 3.5.2-alpha.d2c36ee7
62
index.js
@@ -1,2 +0,2 @@ | ||
// depend on jsts for now https://github.com/bjornharrtell/jsts/blob/master/examples/overlay.html | ||
// depend on jsts for now http://bjornharrtell.github.io/jsts/ | ||
var jsts = require('jsts'); | ||
@@ -10,49 +10,25 @@ | ||
* @param {Feature<Polygon>} poly2 the second polygon | ||
* @return {(Feature<Polygon>|undefined|Feature<MultiLineString>)} if `poly1` and `poly2` overlap, returns a Polygon feature representing the area they overlap; if `poly1` and `poly2` do not overlap, returns `undefined`; if `poly1` and `poly2` share a border, a MultiLineString of the locations where their borders are shared | ||
* @return {(Feature|undefined)} returns a feature representing the point(s) they share (in case of a {@link Point} or {@link MultiPoint}), the borders they share (in case of a {@link LineString} or a {@link MultiLineString}), the area they share (in case of {@link Polygon} or {@link MultiPolygon}). If they do not share any point, returns `undefined`. | ||
* @example | ||
* var poly1 = { | ||
* "type": "Feature", | ||
* "properties": { | ||
* "fill": "#0f0" | ||
* }, | ||
* "geometry": { | ||
* "type": "Polygon", | ||
* "coordinates": [[ | ||
* [-122.801742, 45.48565], | ||
* [-122.801742, 45.60491], | ||
* [-122.584762, 45.60491], | ||
* [-122.584762, 45.48565], | ||
* [-122.801742, 45.48565] | ||
* ]] | ||
* } | ||
* } | ||
* var poly2 = { | ||
* "type": "Feature", | ||
* "properties": { | ||
* "fill": "#00f" | ||
* }, | ||
* "geometry": { | ||
* "type": "Polygon", | ||
* "coordinates": [[ | ||
* [-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 poly1 = polygon([[ | ||
* [-122.801742, 45.48565], | ||
* [-122.801742, 45.60491], | ||
* [-122.584762, 45.60491], | ||
* [-122.584762, 45.48565], | ||
* [-122.801742, 45.48565] | ||
* ]]); | ||
* | ||
* var polygons = { | ||
* "type": "FeatureCollection", | ||
* "features": [poly1, poly2] | ||
* }; | ||
* var poly2 = 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); | ||
* | ||
* //=polygons | ||
* | ||
* //=intersection | ||
@@ -59,0 +35,0 @@ */ |
{ | ||
"name": "@turf/intersect", | ||
"version": "3.3.3", | ||
"version": "3.5.2-alpha.d2c36ee7", | ||
"description": "find the intersection of spatial features", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -15,52 +15,32 @@ # @turf/intersect | ||
```javascript | ||
var poly1 = { | ||
"type": "Feature", | ||
"properties": { | ||
"fill": "#0f0" | ||
}, | ||
"geometry": { | ||
"type": "Polygon", | ||
"coordinates": [[ | ||
[-122.801742, 45.48565], | ||
[-122.801742, 45.60491], | ||
[-122.584762, 45.60491], | ||
[-122.584762, 45.48565], | ||
[-122.801742, 45.48565] | ||
]] | ||
} | ||
} | ||
var poly2 = { | ||
"type": "Feature", | ||
"properties": { | ||
"fill": "#00f" | ||
}, | ||
"geometry": { | ||
"type": "Polygon", | ||
"coordinates": [[ | ||
[-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 poly1 = polygon([[ | ||
[-122.801742, 45.48565], | ||
[-122.801742, 45.60491], | ||
[-122.584762, 45.60491], | ||
[-122.584762, 45.48565], | ||
[-122.801742, 45.48565] | ||
]]); | ||
var polygons = { | ||
"type": "FeatureCollection", | ||
"features": [poly1, poly2] | ||
}; | ||
var poly2 = 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); | ||
//=polygons | ||
//=intersection | ||
``` | ||
Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)> | [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined) \| [Feature](http://geojson.org/geojson-spec.html#feature-objects)<[MultiLineString](http://geojson.org/geojson-spec.html#multilinestring)>)** if `poly1` and `poly2` overlap, returns a Polygon feature representing the area they overlap; if `poly1` and `poly2` do not overlap, returns `undefined`; if `poly1` and `poly2` share a border, a MultiLineString of the locations where their borders are shared | ||
Returns **([Feature](http://geojson.org/geojson-spec.html#feature-objects) \| [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined))** returns a feature representing the point(s) they share (in case of a [Point](http://geojson.org/geojson-spec.html#point) or [MultiPoint](http://geojson.org/geojson-spec.html#multipoint)), the borders they share (in case of a [LineString](http://geojson.org/geojson-spec.html#linestring) or a [MultiLineString](http://geojson.org/geojson-spec.html#multilinestring)), the area they share (in case of [Polygon](http://geojson.org/geojson-spec.html#polygon) or [MultiPolygon](http://geojson.org/geojson-spec.html#multipolygon)). If they do not share any point, returns `undefined`. | ||
<!-- This file is automatically generated. Please don't edit it directly: | ||
if you find an error, edit the source file (likely index.js), and re-run | ||
./scripts/generate-readmes in the turf project. --> | ||
--- | ||
@@ -67,0 +47,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
5781
73
1
65
1