3.0.12 • Published 8 years ago

turf-within v3.0.12

Weekly downloads
11,358
License
MIT
Repository
github
Last release
8 years ago

turf-within

build status

turf within module

turf.within(points, polygons)

Returns a FeatureCollection of points representing all points that fall within a collection of polygons.

Parameters

parametertypedescription
pointsFeatureCollection
polygonsFeatureCollection

Example

var searchWithin = turf.featurecollection([
  turf.polygon([
    [[-46.653,-23.543],
     [-46.634,-23.5346],
     [-46.613,-23.543],
     [-46.614,-23.559],
     [-46.631,-23.567],
     [-46.653,-23.560],
     [-46.653,-23.543]]
  ])
]);
var points = turf.featurecollection([
  turf.point([-46.6318, -23.5523]),
  turf.point([-46.6246, -23.5325]),
  turf.point([-46.6062, -23.5513]),
  turf.point([-46.663, -23.554]),
  turf.point([-46.643, -23.557])]);
var ptsWithin = turf.within(points, searchWithin);
//=points
//=searchWithin
//=ptsWithin

Installation

Requires nodejs.

$ npm install turf-within

Tests

$ npm test