@turf/centroid
Advanced tools
Package description
@turf/centroid is a module within the Turf.js library that calculates the centroid of a given GeoJSON feature. This is useful for finding the geometric center of various shapes such as polygons, lines, and multi-geometries.
Calculate Centroid of a Polygon
This feature calculates the centroid of a polygon. The code sample demonstrates how to create a polygon and then calculate its centroid using the @turf/centroid package.
const turf = require('@turf/centroid');
const polygon = turf.polygon([[
[-81, 41],
[-81, 47],
[-72, 47],
[-72, 41],
[-81, 41]
]]);
const centroid = turf.centroid(polygon);
console.log(centroid);Calculate Centroid of a LineString
This feature calculates the centroid of a LineString. The code sample demonstrates how to create a LineString and then calculate its centroid using the @turf/centroid package.
const turf = require('@turf/centroid');
const line = turf.lineString([
[-83, 30],
[-84, 36],
[-78, 41]
]);
const centroid = turf.centroid(line);
console.log(centroid);Calculate Centroid of a MultiPolygon
This feature calculates the centroid of a MultiPolygon. The code sample demonstrates how to create a MultiPolygon and then calculate its centroid using the @turf/centroid package.
const turf = require('@turf/centroid');
const multiPolygon = turf.multiPolygon([[
[[-81, 41], [-81, 47], [-72, 47], [-72, 41], [-81, 41]]
], [
[[-73, 39], [-73, 45], [-64, 45], [-64, 39], [-73, 39]]
]]);
const centroid = turf.centroid(multiPolygon);
console.log(centroid);Geolib is a library for geospatial calculations. It provides functions to calculate distances, areas, and other geometric properties. While it offers centroid calculations, it is more general-purpose compared to @turf/centroid, which is specifically designed for GeoJSON features.
JSTS (JavaScript Topology Suite) is a library for performing various geometric operations. It includes functions for calculating centroids, but it is more complex and offers a broader range of geometric operations compared to @turf/centroid.
Changelog
6.5.0
@turf/points-with-polygon Add MultiPoint support
(PR https://github.com/Turfjs/turf/pull/2137 - Author @twelch)@turf/dissolve Complete rewrite of the dissolve module to resolve many bugs
(PR https://github.com/Turfjs/turf/pull/2110 - Author @rowanwins)
@turf/mask Complete rewrite of the mask module to resolve many bugs
(PR https://github.com/Turfjs/turf/pull/2130 - Author @rowanwins)
@turf/boolean-valid Add missing dependency to
(PR https://github.com/Turfjs/turf/pull/2094 - Author @rycgar)
@turf/boolean-overlap Improve clarity
(PR https://github.com/Turfjs/turf/pull/2133 - Author @patrickbrett)Readme
Takes one or more features and calculates the centroid using the mean of all vertices. This lessens the effect of small islands and artifacts when calculating the centroid of a set of polygons.
Parameters
Examples
var polygon = turf.polygon([[[-81, 41], [-88, 36], [-84, 31], [-80, 33], [-77, 39], [-81, 41]]]);
var centroid = turf.centroid(polygon);
//addToMap
var addToMap = [polygon, centroid]
Returns Feature<Point> the centroid of the input features
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.
Install this module individually:
$ npm install @turf/centroid
Or install the Turf module that includes it as a function:
$ npm install @turf/turf
FAQs
turf centroid module
We found that @turf/centroid demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.