booleanPointInPolygon

Description

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

Name	Type	Description
point	Coord	input point
polygon	Feature<Polygon | MultiPolygon>	input polygon or multipolygon
options?	Object	Optional parameters (default {})
options.ignoreBoundary?	boolean	True if polygon boundary should be ignored when determining if the point is inside the polygon otherwise false. (default false)

Returns

boolean true if the Point is inside the Polygon; false if the Point is not inside the Polygon

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

Installation

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

import { booleanPointInPolygon } from "@turf/boolean-point-in-polygon";
const result = booleanPointInPolygon(...);

$ npm install @turf/turf

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