New module @turf/bbox-clip 🎉

[DenisCarriere]

New module! @turf/bbox-clip 🎉

Takes a Feature and a bbox and clips the feature to the bbox using lineclip.

Contributors

• Tim Channell @tcql (initial turf-bbox-clip implementation)
• Vladimir Agafonkin @mourner (author of lineclip)
• Denis Carriere @DenisCarriere (TurfJS implementation)

JS Docs

/**
 * Takes a {@link Feature} and a bbox and clips the feature to the bbox using [lineclip](https:/mapbox/lineclip).
 * May result in degenerate edges when clipping Polygons.
 *
 * @name bbox-clip
 * @param {Feature<LineString|MultiLineString|Polygon|MultiPolygon>} feature feature to clip to the bbox
 * @param {Array<number>} bbox extent in [minX, minY, maxX, maxY] order
 * @returns {Feature<LineString|MultiLineString|Polygon|MultiPolygon>} clipped Feature
 * @example
 * var bbox = [0, 0, 10, 10];
 * var poly = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "Polygon",
 *     "coordinates": [[[2, 2], [8, 4], [12, 8], [3, 7], [2, 2]]]
 *   }
 * }
 *
 * var clipped = turf.bboxClip(poly, bbox);
 *
 * //=clipped
 */

Dependencies

"dependencies": {
  "@turf/helpers": "^4.0.1",
  "@turf/invariant": "^4.0.1",
  "lineclip": "^1.1.5"
}

Benchmark Results

linestring-single-line x 1,065,073 ops/sec ±1.11% (90 runs sampled)
linestring x 56,599 ops/sec ±1.17% (90 runs sampled)
multi-linestring x 859,048 ops/sec ±1.01% (91 runs sampled)
multi-polygon x 26,991 ops/sec ±0.87% (94 runs sampled)
polygon-crossing-hole x 25,277 ops/sec ±0.72% (92 runs sampled)
polygon-holes x 27,233 ops/sec ±0.89% (91 runs sampled)
polygon x 21,339 ops/sec ±1.19% (89 runs sampled)

Examples test/out

• Red: clipped lines (results)
• Green: input feature
• Blue: bbox clipping feature

CC: @Turfjs/ownership #281

[DenisCarriere]

👍 Thanks @mourner for reviewing