@turf/centroid
TypeScript icon, indicating that this package has built-in type declarations

6.5.0 • Public • Published

@turf/centroid

centroid

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

  • geojson GeoJSON GeoJSON to be centered
  • options Object Optional Parameters (optional, default {})
    • options.properties Object an Object that is used as the Feature's properties (optional, default {})

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.

Installation

Install this module individually:

$ npm install @turf/centroid

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

$ npm install @turf/turf

Readme

Keywords

Package Sidebar

Install

npm i @turf/centroid

Weekly Downloads

600,444

Version

6.5.0

License

MIT

Unpacked Size

7.89 kB

Total Files

7

Last publish

Collaborators

  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly