centroid

Description

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

Parameters

Name	Type	Description
geojson	GeoJSON	GeoJSON to be centered
options?	Object	Optional Parameters (default {})
options.properties?	Object	an Object that is used as the {@link Feature}'s properties (default {})

Returns

Feature<Point> the centroid of the input object

Examples

var polygon = turf.polygon([
  [
    [-81, 41],
    [-88, 36],
    [-84, 31],
    [-80, 33],
    [-77, 39],
    [-81, 41],
  ],
]);

var centroid = turf.centroid(polygon);

Installation

$ npm install @turf/centroid

import { centroid } from "@turf/centroid";
const result = centroid(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.centroid(...);