AzimuthJS

AzimuthJS

AzimuthJS is a small, stand-alone script/module to calculate distance, azimuth and direction between two points (given the latitude/longitude of those points).

South latitudes are negative, east longitudes are positive.

Installation

Link azimuth.min.js in your HTML :

Load exact version: Latest version is

<script src="https://cdn.jsdelivr.net/gh/theGreski/[email protected]/dist/azimuth.min.js"></script>

Load a version range instead of an exact version:

<script src="https://cdn.jsdelivr.net/gh/theGreski/[email protected]/dist/azimuth.min.js"></script>

Omit the version completely and use "latest" to load the latest one (not recommended for production usage):

<script src="https://cdn.jsdelivr.net/gh/theGreski/AzimuthJS@latest/dist/azimuth.min.js"></script>

Load module in JS:

const azimuth = require('https://cdn.jsdelivr.net/gh/theGreski/AzimuthJS@latest/dist/azimuth.min.js');

Usage

The azimuth function accepts coordinates of two points ({lat: latitude, lng: longitude}, {lat: latitude, lng: longitude}). For example London to New York:

azimuth({lat: 51.509865, lng: -0.118092}, {lat: 40.730610, lng: -73.935242})

The output will look like this:

{
    distance: 55648932,
    units: "m",
    azimuth: 258,
    method: "great-circle",
    direction: "W"
}

Or wrap aroud try catch block to find any validation isues:

try {
  azimuth(9999, -200, "abc", null)
} catch (e) {
  console.error(e)
}

Options

You can configure the following options:

• units
• formula
• distancePrecision
• azimuthPrecision
• directionPrecision

Here's an example specyfying all available options:

azimuth({lat: 51.509865, lng: -0.118092}, {lat: 40.730610, lng: -73.935242},  
  {  
    units: "mi",  
    formula: "great-circle",  
    distancePrecision: 3,  
    azimuthPrecision: 3,  
    directionPrecision: 2  
  }  
)

The output will look like this:

{
    formula: "great-circle",
    distance: 5564892.653,
    units: "mi",
    azimuth: 258.049,
    direction: "W"
}

units

A string indicating units of the distance.

Accepts only:

m for meters,
km for kilometers,
ft for foots,
yd for yards,
mi for miles,
nm for nautical miles

• Default: m

formula

A string indicating calculation formula.

Accepts only: great-circle for Great Circle, rhumb-line for straight line

• Default: great-circle

distancePrecision

A number indicating number of rounding decimal places (precision) for distance measure.

• Default: 0

azimuthPrecision

A number indicating number of rounding decimal places (precision) for bearing measure.

• Default: 0

directionPrecision

A number indicating precision for compass direction measure.

Accepts only:

0 No compass direction,
1 Cardinal directions (N, E, S, W)
2 Intercardinal directions (N, NE, E, SE, S, SW, W, NW)
3 Secondary intercardinal directions (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW)

• Default: 2

Released under the MIT License