What is @turf/envelope?
@turf/envelope is a module from the Turf.js library that allows you to calculate the bounding box (envelope) of a given GeoJSON feature or set of features. This is useful for determining the minimum bounding rectangle that encloses a set of geographical points, lines, or polygons.
What are @turf/envelope's main functionalities?
Calculate Bounding Box for a Point
This feature allows you to calculate the bounding box for a single point. The code sample creates a point at coordinates [10, 20] and then calculates its bounding box.
const turf = require('@turf/turf');
const point = turf.point([10, 20]);
const envelope = turf.envelope(point);
console.log(envelope);
Calculate Bounding Box for a Polygon
This feature allows you to calculate the bounding box for a polygon. The code sample creates a polygon with specified coordinates and then calculates its bounding box.
const turf = require('@turf/turf');
const polygon = turf.polygon([[
[10, 20], [30, 40], [50, 60], [10, 20]
]]);
const envelope = turf.envelope(polygon);
console.log(envelope);
Calculate Bounding Box for Multiple Features
This feature allows you to calculate the bounding box for a collection of features. The code sample creates a point and a line, combines them into a feature collection, and then calculates the bounding box for the entire collection.
const turf = require('@turf/turf');
const point = turf.point([10, 20]);
const line = turf.lineString([[30, 40], [50, 60]]);
const featureCollection = turf.featureCollection([point, line]);
const envelope = turf.envelope(featureCollection);
console.log(envelope);
Other packages similar to @turf/envelope
bbox
The 'bbox' package provides similar functionality to @turf/envelope by calculating the bounding box for GeoJSON features. It is a lightweight alternative but may not offer the extensive set of geospatial operations available in the Turf.js library.
geojson-bbox
The 'geojson-bbox' package is another alternative that focuses on calculating the bounding box for GeoJSON objects. It is simple to use and can be a good choice if you only need bounding box calculations without the additional features provided by Turf.js.
@turf/envelope
envelope
Takes any number of features and returns a rectangular Polygon that encompasses all vertices.
Parameters
Examples
var features = turf.featureCollection([
turf.point([-75.343, 39.984], {"name": "Location A"}),
turf.point([-75.833, 39.284], {"name": "Location B"}),
turf.point([-75.534, 39.123], {"name": "Location C"})
]);
var enveloped = turf.envelope(features);
var addToMap = [features, enveloped];
Returns Feature<Polygon> a rectangular Polygon feature that encompasses all vertices
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/envelope
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
6.2.0
After a bit of hiatus, TurfJS is resuming releases.
⭐️ Major Updates
- ES Modules available for all packages
- Tree shaking should significantly reduce import size of @turf/turf
- Better support for ESM modules (PR https://github.com/Turfjs/turf/pull/1942 - Author @diachedelic)
- Clean-up of test and benchmark running to make publishing easier
- Enforce styling using Prettier
- Enable ESLint and get rid of unused variables
- Upgrade rollup for more correct javascript module builds
- Only include ES5 code
🚀 New Modules
[@turf/boolean-touches
][boolean-touches]
Determines if two features touch but do not intersect
[@turf/boolean-valid
][boolean-valid]
Checks if the geometry is a valid according to the OGC Simple Feature Specification
[@turf/quadrat-analysis
][quadrat-analysis]
Performs a quadrat analysis on a set of points
[@turf/rectangle-grid
][rectangle-grid]
Creates a grid of rectangles from a bounding box
[@turf/voroni
][voronoi]
Typescript types for the options parameter have been fixed
(PR https://github.com/Turfjs/turf/pull/1424 - Author @stevage)
[@turf/points-within-polygon
][points-within-polygon]
Typescript types around the Feature's Properties will now be preserved.
(PR https://github.com/Turfjs/turf/pull/1761 - Author @rugheid)
[@turf/rewind
][rewind]
Typescript types for the 'reverse' option are now correct. Previously it was misnamed as 'reversed'.
(PR https://github.com/Turfjs/turf/pull/1786 - Author @jonnycornwell)
[@turf/difference
][difference]
No longer publishes an .mjs file.
[@turf/meta
][meta]
No longer publishes an .mjs file.
[@turf/tag
][tag]
Add MultiPolygon support.
(PR https://github.com/Turfjs/turf/pull/1996 - Author bryceroney)
🐛 Bug Fixes
-
@turf/centroid
Don't visit first point twice when calculating centroid
(PR https://github.com/Turfjs/turf/pull/1894 - Author @rowanwins)
-
@turf/transform-translate
Better handling of negative distances
(PR https://github.com/Turfjs/turf/pull/1895 - Author @rowanwins)
-
@turf/union
, @turf/difference
, @turf/intersect
Use polygon-clipping library to fix correctness issues
(PR https://github.com/Turfjs/turf/pull/1916 - Authors @mbullington, @ngottlieb)
-
@turf/buffer
Change default number of steps to 8, and actually support the steps option
(PR https://github.com/Turfjs/turf/pull/1931 - Author stevenchanin)
-
@turf/buffer
Fix projection issues that produce undersized buffers at non-equatorial latitudes
(PR https://github.com/Turfjs/turf/pull/1956 - Author dyakovlev)
-
@turf/helpers
Add runtime checks to point() method, fixing an API break
(PR https://github.com/Turfjs/turf/pull/1964)
🏅 New Features/Enhancements
-
@turf/boolean-overlap
Better performance for MultiPoint geometries
(PR https://github.com/Turfjs/turf/pull/1910 - Author @mfedderly)
-
@turf/helpers
Add hectares to convertArea
(PR https://github.com/Turfjs/turf/pull/1943 - Author @DanielJDufour)
-
@turf/great-circle
Update Typescript types to support MultiLineString input
(PR https://github.com/Turfjs/turf/pull/1928 - Author kronick)
📖 Documentation
-
@turf/square-grid
Clarify inputs
(PR https://github.com/Turfjs/turf/pull/1885 - Author @raphael-leger)
-
@turf/greater-circle
Clarify properties option example
(PR https://github.com/Turfjs/turf/pull/1888 - Author @chris-catignani)
⚠️ Breaking Change
-
@turf/line-to-polygon
no longer modifies its input unless the mutate option is true
(PR https://github.com/Turfjs/turf/pull/1879 - Author @MortenBirk)
-
@turf/unkink-polygon
remove Number.prototype.modulo override
(PR https://github.com/Turfjs/turf/pull/1978)