JSPM

  • Created
  • Published
  • Downloads 1002467
  • Score
    100M100P100Q212881F
  • License MIT

Takes two points and finds the bearing angle between them along a Rhumb line.

Package Exports

  • @turf/rhumb-bearing
  • @turf/rhumb-bearing/package.json

Readme

@turf/rhumb-bearing

rhumbBearing

Takes two points and finds the bearing angle between them along a Rhumb line i.e. the angle measured in degrees start the north line (0 degrees)

Parameters

  • start Coord starting Point

  • end Coord ending Point

  • options Object? Optional parameters (optional, default {})

    • options.final boolean calculates the final bearing if true (optional, default false)

Examples

var point1 = turf.point([-75.343, 39.984], {"marker-color": "#F00"});
var point2 = turf.point([-75.534, 39.123], {"marker-color": "#00F"});

var bearing = turf.rhumbBearing(point1, point2);

//addToMap
var addToMap = [point1, point2];
point1.properties.bearing = bearing;
point2.properties.bearing = bearing;

Returns number bearing from north in decimal degrees, between -180 and 180 degrees (positive clockwise)


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/rhumb-bearing

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

$ npm install @turf/turf