Numerous Philanthropic Misanthropes
Have ideas to improve npm?Join in the discussion! »

@turf/rhumb-bearing
TypeScript icon, indicating that this package has built-in type declarations

6.3.0 • Public • Published

@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
    • 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 module individually:

$ npm install @turf/rhumb-bearing

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

$ npm install @turf/turf

Install

npm i @turf/rhumb-bearing

DownloadsWeekly Downloads

205,664

Version

6.3.0

License

MIT

Unpacked Size

11.2 kB

Total Files

7

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar