@turf/voronoi

What is @turf/voronoi?

@turf/voronoi is a module within the Turf.js library that allows you to generate Voronoi diagrams from a set of points. Voronoi diagrams partition a plane into regions based on the distance to a specific set of points, which can be useful in various geospatial analyses.

What are @turf/voronoi's main functionalities?

Generate Voronoi Diagram

This feature allows you to generate a Voronoi diagram from a set of points. The code sample demonstrates how to create Voronoi polygons using a bounding box to limit the extent of the diagram.

const turf = require('@turf/turf');
const points = turf.points([
  [-75.343, 39.984],
  [-75.833, 39.284],
  [-75.534, 39.123],
  [-75.123, 39.567]
]);
const bbox = [-80, 30, -70, 50];
const voronoiPolygons = turf.voronoi(points, {bbox: bbox});
console.log(JSON.stringify(voronoiPolygons));

Other packages similar to @turf/voronoi

d3-voronoi

d3-voronoi is a module within the D3.js library that provides tools for computing Voronoi diagrams. It is highly customizable and integrates well with D3's powerful data visualization capabilities. Compared to @turf/voronoi, d3-voronoi is more focused on visualization and less on geospatial analysis.

voronoi-diagram

voronoi-diagram is a lightweight npm package for generating Voronoi diagrams. It is simple to use and can be a good alternative if you need a straightforward solution for creating Voronoi diagrams without the additional geospatial functionalities provided by @turf/voronoi.

README

@turf/voronoi

voronoi

Takes a FeatureCollection of points, and a bounding box, and returns a FeatureCollection of Voronoi polygons.

The Voronoi algorithim used comes from the d3-voronoi package.

Parameters

• points FeatureCollection<Point> to find the Voronoi polygons around.
• options Object Optional parameters (optional, default {})
  • options.bbox Array<number> clipping rectangle, in [minX, minY, maxX, MaxY] order. (optional, default [-180,-85,180,-85])

Examples

var options = {
  bbox: [-70, 40, -60, 60]
};
var points = turf.randomPoint(100, options);
var voronoiPolygons = turf.voronoi(points, options);

//addToMap
var addToMap = [voronoiPolygons, points];

Returns FeatureCollection<Polygon> a set of polygons, one per input point.

---

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/voronoi

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

$ npm install @turf/turf

Changelog

6.4.0

🏅 New Features/Enhancements

• @turf/boolean-point-on-line Added an epislon option to help in floating point comparison. (PR https://github.com/Turfjs/turf/pull/2051 - Author @okcoker)

🐛 Bug Fixes

• @turf/line-slice-along Fixed a bug where the offset distance equal to the length of the line (PR https://github.com/Turfjs/turf/pull/2030 - Author @EricPKerr)

• @turf/helpers Fixed the conversion ratio for converting meters to yards and vice-versa (PR https://github.com/Turfjs/turf/pull/2046 - Author @anotherhale)

• @turf/center-median Fixed a missing TS type import (PR https://github.com/Turfjs/turf/pull/2044 - Author @Seairth)

• `@turf/bezier-spline Fix a bug ensuring the spline result reaches the end of the input (PR https://github.com/Turfjs/turf/pull/2090 - Author @the-nemz)

📖 Documentation

• @turf/transform-rotate and @turf/ellipse) Improve documentation for angle parameter (PR https://github.com/Turfjs/turf/pull/2016 - Author @pasieronen)

• @turf/line-chunk Fix an invalid anchor (PR https://github.com/Turfjs/turf/pull/2071 - Author @GraxMonzo)

• @turf/distance Enhance distance doco so supported inputs are clearer (PR https://github.com/Turfjs/turf/pull/2032 - Author @rowanwins)

🔔 Misc

• @turf/concave Replace deprecated topojson dependency (PR https://github.com/Turfjs/turf/pull/2037 - Author @elliots)

• Work towards enabling TS Strict Mode (PR https://github.com/Turfjs/turf/pull/2053 - Author @mfedderly)