| .. | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
@turf/ellipse
ellipse
Takes a Point and calculates the ellipse polygon given two semi-axes expressed in variable units and steps for precision.
Parameters
-
centerCoord center point -
xSemiAxisnumber semi (major) axis of the ellipse along the x-axis -
ySemiAxisnumber semi (minor) axis of the ellipse along the y-axis -
optionsObject Optional parameters (optional, default{})options.anglenumber angle of rotation in decimal degrees, positive clockwise (optional, default0)options.pivotCoord point around which any rotation will be performed (optional, defaultcenter)options.stepsnumber number of steps (optional, default64)options.unitsstring unit of measurement for axes (optional, default'kilometers')options.propertiesObject 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 single module individually:
$ npm install @turf/ellipse
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf