@turf/great-circle

@turf/great-circle

greatCircle

Calculate great circles routes as LineString or MultiLineString. If the start and end points span the antimeridian, the resulting feature will be split into a MultiLineString. If the start and end positions are the same then a LineString will be returned with duplicate coordinates the length of the npoints option.

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, {properties: {name: 'Seattle to DC'}});

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

Returns Feature<(LineString | MultiLineString)> 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 single module individually:

$ npm install @turf/great-circle

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf