New module @turf/polygon-slice

New module ~@turf/slice~ @turf/polygon-slice, currently on slice branch

Contributions and comments are welcomed before we publish to TurfJS.

Example

var sliced = turf.polygonSlice(polygon, linestring);

Current fallbacks of PolyK

• Linestring is limited to two segments
• Coordinate precision is limited to a few decimal points.
• Output & Input is a very strange array [x1 y1, x2, y2, …]

JSDocs

/**
 * Takes a {@link Polygon} and cuts it with a {@link Linestring}. Note the linestring must be a straight line (eg made of only two points).
 * Properties from the input polygon will be retained on output polygons. Internally uses [polyK](http://polyk.ivank.net/) to perform split.
 *
 * @name slice
 * @param {Feature<Polygon>} poly - single Polygon Feature
 * @param {Feature<LineString>} line - single Polyline Feature
 * @return {FeatureCollection<Polygon>} A FeatureCollection of polygons
 */

Input

Output

Benchmark

$ node bench.js
simple x 117,605 ops/sec ±0.57% (98 runs sampled)

CC: @Turfjs/ownership

[gdrouet]

Looking for this feature! It would be useful to split polygons that are too big.

[rowanwins]

Thanks for those links @alexgleith and your work on the module, will try and take a look this evening and see if I can find a clever way around it.