Package Exports

@turf/great-circle

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/great-circle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/great-circle

greatCircle

Calculate great circles routes as LineString

Parameters

start Feature<Point> source point feature
end Feature<Point> destination point feature
properties [Any] line feature properties (optional, default {})
npoints [number] number of points (optional, default 100)
offset [number] offset controls the likelyhood that lines will be split which cross the dateline. The higher the number the more likely. (optional, default 10)

Examples

var start = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Point",
    "coordinates": [-122, 48]
  }
}
var end = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Point",
    "coordinates": [-77, 39]
  }
}
var line = turf.greatCircle(start, end, {'name': 'Seattle to DC'});
//=line

Returns Feature<LineString> great circle line feature

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/great-circle

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

$ npm install @turf/turf