JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4412957
  • Score
    100M100P100Q200378F
  • License ISC

A really fast JavaScript library for Delaunay triangulation of 2D points

Package Exports

  • delaunator
  • delaunator/delaunator.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (delaunator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

delaunator Build Status

A really fast JavaScript library for Delaunay triangulation of 2D points.

Projects based on Delaunator:

  • d3-delaunay for Voronoi diagrams, search, traversal and rendering.
  • d3-geo-voronoi for Delaunay triangulations and Voronoi diagrams on a sphere (e.g. for geographic locations).
  • fogleman/delaunay is a port of Delaunator to Go.
Delaunay triangulation example

Example

const points = [[168, 180], [168, 178], [168, 179], [168, 181], [168, 183], ...];

const delaunay = Delaunator.from(points);
console.log(delaunay.triangles);
// [623, 636, 619,  636, 444, 619, ...]

Install

Install with NPM (npm install delaunator) or Yarn (yarn add delaunator), then:

// import as an ES module
import Delaunator from 'delaunator';

// or require in Node / Browserify
const Delaunator = require('delaunator');

Or use a browser build directly:

<script src="https://unpkg.com/delaunator@2.0.3/delaunator.min.js"></script> <!-- minified build -->
<script src="https://unpkg.com/delaunator@2.0.3/delaunator.js"></script> <!-- dev build -->

API Reference

Delaunator.from(points[, getX, getY])

Constructs a delaunay triangulation object given an array of points ([x, y] by default). getX and getY are optional functions of the form (point) => value for custom point formats. Duplicate points are skipped.

new Delaunator(coords)

Constructs a delaunay triangulation object given a typed array of point coordinates of the form: [x0, y0, x1, y1, ...].

delaunay.triangles

A flat Int32Array array of triangle vertex indices (each group of three numbers forms a triangle). All triangles are directed counterclockwise.

To get the coordinates of all triangles, use:

for (let i = 0; i < triangles.length; i += 3) {
    coordinates.push([
        points[triangles[i]],
        points[triangles[i + 1]],
        points[triangles[i + 2]]
    ]);
}

delaunay.halfedges

A flat Int32Array array of triangle half-edge indices that allows you to traverse the triangulation. i-th half-edge in the array corresponds to vertex triangles[i] the half-edge is coming from. halfedges[i] is the index of a twin half-edge in an adjacent triangle (or -1 for outer half-edges on the convex hull).

The flat array-based data structures might be counterintuitive, but they're one of the key reasons this library is fast.

Performance

Benchmark results against other Delaunay JS libraries (npm run bench on Macbook Pro Retina 15" 2017, Node v10.9.0):

  uniform 100k uniform 1 million gauss 100k gauss 1 million grid 100k grid 1 million degen 100k degen 1 million
delaunator 97ms 1.28s 70ms 1s 81ms 988ms 48ms 917ms
faster‑delaunay 473ms 4.27s 411ms 4.62s 272ms 4.3s 68ms 810ms
incremental‑delaunay 547ms 5.9s 505ms 6.08s 172ms 2.11s 528ms 6.09s
d3‑voronoi 972ms 15.04s 909ms 13.86s 358ms 5.55s 720ms 11.13s
delaunay‑fast 3.8s 132s 4s 138s 12.57s 399s timeout timeout
delaunay 4.85s 156s 5.73s 178s 15.05s 326s timeout timeout
delaunay‑triangulate 2.24s OOM 2.04s OOM OOM OOM 1.51s OOM

Papers

The algorithm is based on ideas from the following papers: