@turf/circle

What is @turf/circle?

@turf/circle is a module within the Turf.js library that allows you to create circular polygons. It is useful for geospatial analysis and manipulation, enabling you to generate circles with a specified radius around a given point.

What are @turf/circle's main functionalities?

Create a Circle

This feature allows you to create a circle polygon with a specified radius around a given center point. The `steps` option defines the number of points used to approximate the circle, and the `units` option specifies the unit of measurement for the radius.

const turf = require('@turf/turf');
const center = [0, 0];
const radius = 5;
const options = { steps: 64, units: 'kilometers' };
const circle = turf.circle(center, radius, options);
console.log(circle);

Customizing Circle Properties

This feature allows you to customize the properties of the circle, such as the number of steps for approximation, the units of measurement, and additional properties like a name.

const turf = require('@turf/turf');
const center = [0, 0];
const radius = 5;
const options = { steps: 32, units: 'miles', properties: { name: 'My Circle' } };
const circle = turf.circle(center, radius, options);
console.log(circle);

Other packages similar to @turf/circle

leaflet

Leaflet is a popular open-source JavaScript library for mobile-friendly interactive maps. It provides similar functionality for creating circles on maps, but it is more focused on rendering and interaction rather than geospatial analysis.

openlayers

OpenLayers is a high-performance, feature-packed library for all your mapping needs. It offers similar capabilities for creating and manipulating circles, but it is more comprehensive and includes a wide range of other geospatial functionalities.

geolib

Geolib is a small library to provide basic geospatial operations like distance calculation, conversion of units, and bounding boxes. It can create circles, but it is more lightweight and less feature-rich compared to @turf/circle.

README

@turf/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
• steps [number] number of steps (optional, default 64)
• units [string] miles, kilometers, degrees, or radians (optional, default kilometers)
• properties [Object] properties (optional, default {})

Examples

var center = [-75.343, 39.984];
var radius = 5;
var steps = 10;
var units = 'kilometers';
var properties = {foo: 'bar'};

var circle = turf.circle(center, radius, steps, units, properties);

//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 @turf/circle

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

$ npm install @turf/turf

Changelog

4.7.0

🚀 New Modules

[@turf/projection][projection]

• toMercator: Converts a WGS84 GeoJSON object into Mercator (EPSG:900913) projection
• toWgs84: Converts a Mercator (EPSG:900913) GeoJSON object into WGS84 projection

(PR https://github.com/Turfjs/turf/pull/927 - Author @stebogit)

[@turf/point-to-line-distance][point-to-line-distance]

Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the minimum distance between the point and any segment of the LineString.

(PR https://github.com/Turfjs/turf/pull/925 - Author @stebogit)

[@turf/boolean-within][boolean-within]

Boolean-within returns true if the first geometry is completely within the second geometry. The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b). Boolean-within returns the exact opposite result of the [@turf/boolean-contains][boolean-contains].

(PR https://github.com/Turfjs/turf/pull/924 - Author @rowanwins)

🏅 New Features/Enhancements

• Updates [@turf/unkink-polygon][unkink-polygon] testing & added flattenEach instead of using flatten. (PR https://github.com/Turfjs/turf/pull/889)
• [@turf/concave][concave] refactoring, replacing [@turf/union][union] with geojson-dissolve to increase speed and added support to null geometries (PR https://github.com/Turfjs/turf/pull/907 - Contributor @stebogit @DenisCarriere)
• Adds doc note on [@turf/polygonize][polygonize] about "Edges must be correctly noded" (PR https://github.com/Turfjs/turf/pull/898 - Contributor @stebogit @NickCis)
• Adds support to foreign Members to [@turf/clone][clone] (PR https://github.com/Turfjs/turf/pull/904 - Contributor @DenisCarriere)
• Extends support of any GeoJSON to [@turf/simplify][simplify] (PR https://github.com/Turfjs/turf/pull/903 - Contributor @DenisCarriere @stebogit)
• Adds new isNumber function and improves type checking for few [@turf/helpers][helpers] methods (PR https://github.com/Turfjs/turf/pull/920 - Contributor @DenisCarriere @stebogit)
• Adds throw errors to invalid MultiPolygons for [@turf/simplify][simplify] (PR https://github.com/Turfjs/turf/pull/922 - Contributor @DenisCarriere)

🐛 Bug Fixes

• Fixes @turf/bbox-clip point intersection handling, adding sanity-checks the lineclip output (PR https://github.com/Turfjs/turf/pull/886)
• Fixes [@turf/line-split][line-split] endpoint case handling applying [@turf/truncate][truncate] on splitter (PR https://github.com/Turfjs/turf/pull/892 and https://github.com/Turfjs/turf/pull/855 - Contributor @stebogit)
• Fixes [@turf/intersect][intersect] throwing "uncaught exception", adding [@turf/truncate][truncate] to inputs and returning Feature<null> if no geometry (PR https://github.com/Turfjs/turf/pull/890 - Contributor @stebogit @vicvolk)
• Fixes [@turf/hex-grid][hex-grid] not properly cloning the last ring vertex (PR https://github.com/Turfjs/turf/pull/897 - Contributor @stebogit @DenisCarriere)
• Fixes [@turf/boolean-disjoint][boolean-disjoint] incorrect behaviour where a poly was completely contained within another poly (PR https://github.com/Turfjs/turf/pull/908 - Contributor @rowanwins)
• Fixes [@turf/simplify][simplify] process pending on particular geometries, applying [@turf/clean-coords][clean-coords] to input. (PR https://github.com/Turfjs/turf/pull/903 - Contributor @stebogit @DenisCarriere)
• Fixes boolean properties not being translated with [@turf/clone][clone] (PR https://github.com/Turfjs/turf/pull/909 - Contributor @DenisCarriere)
• Fixes [@turf/boolean-contains][boolean-contains] incorrect output when checking two polygons (PR https://github.com/Turfjs/turf/pull/923 - Contributor @rowanwins @DenisCarriere)