@turf/great-circle

@turf/great-circle

greatCircle

Calculate great circles routes as LineString

Parameters

• start (Geometry | Feature<Point> | Array<number>) source point feature
• end (Geometry | Feature<Point> | Array<number>) destination point feature
• properties [Object] 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 greatCircle = turf.greatCircle(start, end, {'name': 'Seattle to DC'});

//addToMap
var addToMap = [start, end, greatCircle]

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