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

7.0.0 • Public • Published

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

$ npm install @turf/bearing

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

$ npm install @turf/turf

Readme

Keywords

Package Sidebar

Install

npm i @turf/bearing

Weekly Downloads

698,844

Version

7.0.0

License

MIT

Unpacked Size

15.4 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly