@turf/ellipse

turf ellipse module

Usage no npm install needed!

<script type="module">
  import turfEllipse from 'https://cdn.skypack.dev/@turf/ellipse';
</script>

README

@turf/ellipse

ellipse

Takes a Point and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.

Parameters

  • center Coord center point
  • xSemiAxis number semi (major) axis of the ellipse along the x-axis
  • ySemiAxis number semi (minor) axis of the ellipse along the y-axis
  • options Object Optional parameters (optional, default {})
    • options.angle number angle of rotation (along the vertical axis), from North in decimal degrees, negative clockwise (optional, default 0)
    • options.pivot Coord point around which the rotation will be performed (optional, default 'origin')
    • options.steps number number of steps (optional, default 64)
    • options.units string unit of measurement for axes (optional, default 'kilometers')
    • options.properties Object properties (optional, default {})

Examples

var center = [-75, 40];
var xSemiAxis = 5;
var ySemiAxis = 2;
var ellipse = turf.ellipse(center, xSemiAxis, ySemiAxis);

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

Returns Feature<Polygon> ellipse 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/ellipse

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

$ npm install @turf/turf