@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 = {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Polygon",
        "coordinates": [[
          [-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 = {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-46.6318, -23.5523]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-46.6246, -23.5325]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-46.6062, -23.5513]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-46.663, -23.554]
      }
    }, {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "type": "Point",
        "coordinates": [-46.643, -23.557]
      }
    }
  ]
};

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

//=points

//=searchWithin

//=ptsWithin

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

Changelog

4.1.0

New Modules

• @turf/line-arc
• @turf/polygon-to-linestring
• @turf/bbox-clip
• @turf/line-overlap

Enhancements

• added centered param to point-grid (PR: https://github.com/Turfjs/turf/pull/650)
• Single module.export helpers, invariant & meta (Commit: https://github.com/Turfjs/turf/commit/9cebb2100cf545fec49488c80140909ab54358b5)

Bug Fixes

• Turf.invariant fails on string value as coordinate (PR: https://github.com/Turfjs/turf/pull/643)
• Handle precision=0 turf-truncate (PR: https://github.com/Turfjs/turf/pull/641)
• Added radiansToDistance, distanceToRadians & distanceToDegrees to Turf core library from @turf/helpers. (Commit: https://github.com/Turfjs/turf/commit/a88d77a3e7f76860b3c138a716da8b603a407c8e)
• Removed process.hrtime in @turf/polygon-unkink(issue: https://github.com/mclaeysb/simplepolygon/issues/5)