Package Exports

@turf/centroid

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/centroid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@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
properties [Object] an Object that is used as the Feature's properties

Examples

var polygon = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Polygon",
    "coordinates": [[[-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