@spatial/boolean-contains

turf boolean-contains module

Usage no npm install needed!

<script type="module">
  import spatialBooleanContains from 'https://cdn.skypack.dev/@spatial/boolean-contains';
</script>

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