@turf/circle

@turf/circle

circle

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

Parameters

• center (Feature<Point> | Array<number>) center point

• radius number radius of the circle

• options Object Optional parameters (optional, default {})

  • options.steps number number of steps (optional, default 64)
  • options.units Units Supports all valid Turf Units (optional, default 'kilometers')
  • options.properties Object properties (optional, default {})

Examples

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<Polygon> circle polygon

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 single module individually:

$ npm install @turf/circle

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

$ npm install @turf/turf