nickcis/polygonize

Javascript Implementation of GEOS's Polygonize function

Polygonize

Polygonizes a set of Geometrys which contain linework that represents the edges of a planar graph. It's basically an implementation of GEOS's Polygonizer.

Although, the algorithm is the same as GEOS, it isn't a literal transcription of the C++ source code. It was rewriten in order to get a more javascript like code.

JSDoc

/**
 * Polygonizes {@link LineString|(Multi)LineString(s)} into {@link Polygons}.
 *
 * Implementation of GEOSPolygonize function (`geos::operation::polygonize::Polygonizer`).
 *
 * Polygonizes a set of lines that represents edges in a planar graph. Edges must be correctly
 * noded, i.e., they must only meet at their endpoints.
 *
 * The implementation correctly handles:
 *
 * - Dangles: edges which have one or both ends which are not incident on another edge endpoint.
 * - Cut Edges (bridges): edges that are connected at both ends but which do not form part of a polygon.
 *
 * @name polygonize
 * @param {FeatureCollection|Geometry|Feature<LineString|MultiLineString>} geoJson Lines in order to polygonize
 * @returns {FeatureCollection<Polygon>} Polygons created
 * @throws {Error} if geoJson is invalid.
 */

Example

This example is the test found in test/in/complex.geojson.

const polygonize = require('polygonize'),
    fs = require('fs'),
    input = JSON.parse(fs.readFileSync('./test/in/complex.geojson'));

console.log(JSON.stringify(polygonize(input)));

The input as GeoJson LineString:

Turned into polygons:

Documentation

Polygonizes (Multi)LineString(s) into Polygons.

Implementation of GEOSPolygonize function (geos::operation::polygonize::Polygonizer).

Polygonizes a set of lines that represents edges in a planar graph. Edges must be correctly noded, i.e., they must only meet at their endpoints.

The implementation correctly handles:

• Dangles: edges which have one or both ends which are not incident on another edge endpoint.
• Cut Edges (bridges): edges that are connected at both ends but which do not form part of a polygon.

Parameters

• geojson (FeatureCollection | Geometry | Feature<(LineString | MultiLineString)>) Lines in order to polygonize

• Throws Error if geoJson is invalid.

Returns FeatureCollection<Polygon> Polygons created

Installation

Install this module individually:

$ npm install polygonize

polygonize's Issues

err Error: Each LinearRing of a Polygon must have 4 or more Positions.

Error: Each LinearRing of a Polygon must have 4 or more Positions.
    at polygon (C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\@turf\helpers\dist\js\index.js:233:19)
    at EdgeRing.toPolygon (C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\EdgeRing.js:171:50)
    at EdgeRing.getEnvelope (C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\EdgeRing.js:182:59)
    at C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\EdgeRing.js:219:33
    at Array.forEach (<anonymous>)
    at Function.findEdgeRingContaining (C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\EdgeRing.js:218:17)
    at C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\index.js:58:28
    at Array.forEach (<anonymous>)
    at polygonize (C:\Users\GurumNyang\Documents\Github\PZ_seoul\node_modules\polygonize\cjs\index.js:57:9)
    at C:\Users\GurumNyang\Documents\Github\PZ_seoul\src\readOsm.js:314:36

Support for ES6 Modules?

Trying to convert TurfJS to ES modules, would it be possible to support ES modules in this library?

Also we're releasing v5.0, so might be a good idea to sync up the dependencies.

I can internalize this library into TurfJS for now until this library gets updated to ES modules.