@turf/points-within-polygon

pointsWithinPolygon

Finds Points or MultiPoint coordinate positions that fall within (Multi)Polygon(s).

Parameters

• points (Feature | FeatureCollection<(Point | MultiPoint)>) Point(s) or MultiPoint(s) as input search
• polygons (FeatureCollection | Geometry | Feature<(Polygon | MultiPolygon)>) (Multi)Polygon(s) to check if points are within

Examples

var points = turf.points([
    [-46.6318, -23.5523],
    [-46.6246, -23.5325],
    [-46.6062, -23.5513],
    [-46.663, -23.554],
    [-46.643, -23.557]
]);

var searchWithin = 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 ptsWithin = turf.pointsWithinPolygon(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 | MultiPoint)> Point(s) or MultiPoint(s) with positions that land within at least one polygon. The geometry type will match what was passsed in

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

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

$ npm install @turf/turf