@turf/within

@turf/within

within

Takes a set of points and a set of polygons and returns the points that fall within the polygons.

Parameters

• points FeatureCollection<Point> input points
• polygons FeatureCollection<Polygon> input polygons

Examples

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

//addToMap
var addToMap = [points, searchWithin, ptsWithin]
turf.featureEach(ptsWithin, function (currentFeature) {
  currentFeature.properties['marker-size'] = 'large';
  currentFeature.properties['marker-color'] = '#000';
});

Returns FeatureCollection<Point> points that land within at least one polygon

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/within

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

$ npm install @turf/turf