Wondering what’s next for npm?Check out our public roadmap! »

    @turf/circle
    TypeScript icon, indicating that this package has built-in type declarations

    6.4.0 • Public • Published

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

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

    $ npm install @turf/turf

    Install

    npm i @turf/circle

    DownloadsWeekly Downloads

    181,121

    Version

    6.4.0

    License

    MIT

    Unpacked Size

    9.59 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar