@turf/bearing

turf bearing module

Usage no npm install needed!

<script type="module">
  import turfBearing from 'https://cdn.skypack.dev/@turf/bearing';
</script>

README

@turf/bearing

bearing

Takes two points and finds the geographic bearing between them, i.e. the angle measured in degrees from 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]);
var point2 = turf.point([-75.534, 39.123]);

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

//addToMap
var addToMap = [point1, point2]
point1.properties['marker-color'] = '#f00'
point2.properties['marker-color'] = '#0f0'
point1.properties.bearing = bearing

Returns number bearing 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/bearing

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

$ npm install @turf/turf