Miss any of our Open RFC calls?Watch the recordings here! »

@turf/boolean-contains

6.0.1 • Public • Published

@turf/boolean-contains

booleanContains

Boolean-contains returns True if the second geometry is completely contained by the first geometry. The interiors of both geometries must intersect and, the interior and boundary of the secondary (geometry b) must not intersect the exterior of the primary (geometry a). Boolean-contains returns the exact opposite result of the @turf/boolean-within.

Parameters

Examples

var line = turf.lineString([[1, 1], [1, 2], [1, 3], [1, 4]]);
var point = turf.point([1, 2]);
 
turf.booleanContains(line, point);
//=true

Returns boolean true/false


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/boolean-contains

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

$ npm install @turf/turf

Diagrams

esri-contains

Install

npm i @turf/boolean-contains

DownloadsWeekly Downloads

112,448

Version

6.0.1

License

MIT

Unpacked Size

14.9 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar