pointsWithinPolygon

Description

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

Parameters

Name	Type	Description
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

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

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.56],
    [-46.653, -23.543],
  ],
]);

var ptsWithin = turf.pointsWithinPolygon(points, searchWithin);

Installation

$ npm install @turf/points-within-polygon

import { pointsWithinPolygon } from "@turf/points-within-polygon";
const result = pointsWithinPolygon(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.pointsWithinPolygon(...);