@spatial/boolean-contains
@spatial/boolean-contains
npm i @spatial/boolean-contains
@spatial/boolean-contains

@spatial/boolean-contains

A modular geospatial engine written in JavaScript

by Turfjs

2.0.0 (see all)License:MITTypeScript:Built-In
npm i @spatial/boolean-contains
Readme

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

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

$ npm install @turf/turf

Downloads/wk

2

GitHub Stars

7.5K

LAST COMMIT

9mos ago

MAINTAINERS

2

CONTRIBUTORS

148

OPEN ISSUES

234

OPEN PRs

21
VersionTagPublished
2.0.0
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate