@turf/boolean-disjoint

What is @turf/boolean-disjoint?

@turf/boolean-disjoint is a module from the Turf.js library that provides geospatial analysis tools. This specific module is used to determine if two geometries are disjoint, meaning they do not share any points in common.

What are @turf/boolean-disjoint's main functionalities?

Check if two geometries are disjoint

This feature allows you to check if two geometries (e.g., points, lines, polygons) do not share any points in common. In this example, two points are checked to see if they are disjoint.

const turf = require('@turf/turf');
const booleanDisjoint = require('@turf/boolean-disjoint');

const point1 = turf.point([2, 2]);
const point2 = turf.point([4, 4]);
const disjoint = booleanDisjoint(point1, point2);
console.log(disjoint); // true

Check if a polygon and a line are disjoint

This feature allows you to check if a polygon and a line are disjoint. In this example, a polygon and a line are checked to see if they do not share any points in common.

const turf = require('@turf/turf');
const booleanDisjoint = require('@turf/boolean-disjoint');

const polygon = turf.polygon([[
  [0, 0], [0, 5], [5, 5], [5, 0], [0, 0]
]]);
const line = turf.lineString([[6, 6], [7, 7]]);
const disjoint = booleanDisjoint(polygon, line);
console.log(disjoint); // true

Other packages similar to @turf/boolean-disjoint

jsts

JSTS is a JavaScript library of spatial predicates and functions for processing geometry. It provides similar functionalities to @turf/boolean-disjoint, such as checking spatial relationships between geometries. However, JSTS is a more comprehensive library that includes a wider range of geometric operations.

geolib

Geolib is a library to provide basic geospatial operations like distance calculation, bounding boxes, and more. While it does not specifically focus on boolean disjoint operations, it offers a variety of geospatial utilities that can be used in conjunction with other libraries to achieve similar results.

README

@turf/boolean-disjoint

booleanDisjoint

Boolean-disjoint returns (TRUE) if the intersection of the two geometries is an empty set.

Parameters

• feature1 (Geometry | Feature<any>) GeoJSON Feature or Geometry

• feature2 (Geometry | Feature<any>) GeoJSON Feature or Geometry

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

  • options.ignoreSelfIntersections boolean ignores self-intersections on input features (optional, default false)

Examples

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

turf.booleanDisjoint(line, point);
//=true

Returns boolean true if the intersection is an empty set, false otherwise

---

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-disjoint

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

$ npm install @turf/turf

Diagrams