@turf/voronoi

turf voronoi module

Usage no npm install needed!

<script type="module">
  import turfVoronoi from 'https://cdn.skypack.dev/@turf/voronoi';
</script>

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