@turf/boolean-point-in-polygon

What is @turf/boolean-point-in-polygon?

@turf/boolean-point-in-polygon is a module from the Turf.js library that allows you to determine if a given point is inside a polygon. This is useful for geospatial analysis, such as determining if a location falls within a specific area or boundary.

What are @turf/boolean-point-in-polygon's main functionalities?

Check if a point is inside a polygon

This feature allows you to check if a given point is inside a specified polygon. The code sample demonstrates creating a point and a polygon, and then using the booleanPointInPolygon function to determine if the point is inside the polygon.

const turf = require('@turf/turf');

const point = turf.point([2, 2]);
const polygon = turf.polygon([[
  [0, 0],
  [0, 5],
  [5, 5],
  [5, 0],
  [0, 0]
]]);

const isInside = turf.booleanPointInPolygon(point, polygon);
console.log(isInside); // true

Other packages similar to @turf/boolean-point-in-polygon

point-in-polygon

The 'point-in-polygon' package provides similar functionality to @turf/boolean-point-in-polygon by allowing you to check if a point is inside a polygon. However, it is a more lightweight and standalone package compared to the comprehensive Turf.js library.

geolib

The 'geolib' package offers a wide range of geospatial functions, including checking if a point is inside a polygon. It is more versatile and includes additional features like distance calculations, but it may be more complex to use for simple point-in-polygon checks compared to @turf/boolean-point-in-polygon.

README

@turf/boolean-point-in-polygon

booleanPointInPolygon

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 Coord input point

• polygon Feature<(Polygon | MultiPolygon)> input polygon or multipolygon

• options Object Optional parameters (optional, default {})

  • options.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.booleanPointInPolygon(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 single module individually:

$ npm install @turf/boolean-point-in-polygon

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

$ npm install @turf/turf