27 lines
964 B
TypeScript
Executable File
27 lines
964 B
TypeScript
Executable File
import { Coord } from "@turf/helpers";
|
|
/**
|
|
* Takes two {@link Point|points} and finds the geographic bearing between them,
|
|
* i.e. the angle measured in degrees from the north line (0 degrees)
|
|
*
|
|
* @name bearing
|
|
* @param {Coord} start starting Point
|
|
* @param {Coord} end ending Point
|
|
* @param {Object} [options={}] Optional parameters
|
|
* @param {boolean} [options.final=false] calculates the final bearing if true
|
|
* @returns {number} bearing in decimal degrees, between -180 and 180 degrees (positive clockwise)
|
|
* @example
|
|
* 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
|
|
*/
|
|
export default function bearing(start: Coord, end: Coord, options?: {
|
|
final?: boolean;
|
|
}): number;
|