archive-gh-me/turf
1
0
Fork 0
mirror of https://github.com/Turfjs/turf.git synced 2026-02-01 16:57:21 +00:00
Code Issues Projects Releases Wiki Activity
turf/packages/turf-bbox-clip
History
mfedderly cf7a0c507b
Do the 7.0.0-alpha.1 release (#2493) 
* update changelog

* v7.0.0-alpha.1

* More changelog
2023-09-18 19:41:14 -04:00
..
lib
Migrate to @types/geojson package (#2158)
2021-10-24 23:07:07 -07:00
test
Add Prettier and ESLint to the builds (#1965)
2020-12-08 19:24:15 -05:00
bench.js
Enable more lint rules (#2108)
2021-06-22 18:42:21 -04:00
index.ts
Migrate to @types/geojson package (#2158)
2021-10-24 23:07:07 -07:00
LICENSE
New module @turf/bbox-clip 🎉 (#652)
2017-04-08 23:49:20 -04:00
package.json
Do the 7.0.0-alpha.1 release (#2493)
2023-09-18 19:41:14 -04:00
README.md
Fix docs generation (#2279)
2022-04-02 12:52:52 -04:00
test.js
Add Prettier and ESLint to the builds (#1965)
2020-12-08 19:24:15 -05:00
tsconfig.json
Standardize Typescript builds (#1849)
2020-03-15 19:15:03 -04:00

README.md

@turf/bbox-clip

bboxClip

Takes a Feature and a bbox and clips the feature to the bbox using lineclip. May result in degenerate edges when clipping Polygons.

Parameters

Examples

var bbox = [0, 0, 10, 10];
var poly = turf.polygon([[[2, 2], [8, 4], [12, 8], [3, 7], [2, 2]]]);

var clipped = turf.bboxClip(poly, bbox);

//addToMap
var addToMap = [bbox, poly, clipped]

Returns Feature<(LineString | MultiLineString | Polygon | MultiPolygon)> clipped Feature

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/bbox-clip

Or install the Turf module that includes it as a function:

$ npm install @turf/turf