@turf/inside

@turf/inside

inside

Takes a Point and a Polygon or MultiPolygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

Parameters

• point Feature<Point> input point
• polygon Feature<(Polygon | MultiPolygon)> input polygon or multipolygon
• ignoreBoundary [boolean] True if polygon boundary should be ignored when determining if the point is inside the polygon otherwise false. (optional, default false)

Examples

var pt = turf.point([-77, 44]);
var poly = turf.polygon([[
  [-81, 41],
  [-81, 47],
  [-72, 47],
  [-72, 41],
  [-81, 41]
]]);

turf.inside(pt, poly);
//= true

Returns boolean true if the Point is inside the Polygon; false if the Point is not inside the 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/inside

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

$ npm install @turf/turf