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

2.0.0 • Public • Published

@spatial/great-circle

greatCircle

Calculate great circles routes as LineString

Parameters

  • start Coord source point feature
  • end Coord destination point feature
  • options Object Optional parameters (optional, default {})
    • options.properties Object line feature properties (optional, default {})
    • options.npoints number number of points (optional, default 100)
    • options.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 = turf.point([-122, 48]);
var end = turf.point([-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 @spatial/great-circle

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @spatial/great-circle

Weekly Downloads

2

Version

2.0.0

License

MIT

Unpacked Size

36.7 kB

Total Files

8

Last publish

Collaborators

  • normanbreau
  • tpnormanbreau