@turf/circle

circle

Takes a [Point][1] and calculates the circle polygon given a radius in [Units][2]; and steps for precision.

$3

* center ([Feature][3]<[Point][1]> | [Array][4]<[number][5]>) center point
* radius [number][5] radius of the circle
* options [Object][6] Optional parameters (optional, default {})

* options.steps [number][5] number of steps (optional, default 64)
* options.units Units Supports all valid Turf [Units][2] (optional, default 'kilometers')
* options.properties [Object][6] properties (optional, default {})

$3

``javascript
var center = [-75.343, 39.984];
var radius = 5;
var options = {steps: 10, units: 'kilometers', properties: {foo: 'bar'}};
var circle = turf.circle(center, radius, options);

//addToMap
var addToMap = [turf.point(center), circle]
`

Returns [Feature][3]<[Polygon][7]> circle polygon

[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2

[2]: https://turfjs.org/docs/api/types/Units

[3]: https://tools.ietf.org/html/rfc7946#section-3.2

[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array

[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[7]: https://tools.ietf.org/html/rfc7946#section-3.1.6

---

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.

$3

Install this single module individually:

`sh
$ npm install @turf/circle
`

Or install the all-encompassing @turf/turf module that includes all modules as functions:

`sh
$ npm install @turf/turf
``