@spatial/circle

turf circle module

Usage no npm install needed!

<script type="module">
  import spatialCircle from 'https://cdn.skypack.dev/@spatial/circle';
</script>

README

@spatial/circle

circle

Takes a Point and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; 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 string miles, kilometers, degrees, or radians (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 module individually:

$ npm install @spatial/circle

Or install the Turf module that includes it as a function:

$ npm install @turf/turf