Skip to content

Latest commit

 

History

History
 
 

turf-centroid

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@turf/centroid

centroid

Computes the centroid as the mean of all vertices within the object.

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 object


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