turf rhumb-destination module
npm install @spatial/rhumb-destinationReturns the destination [Point][1] having travelled the given distance along a Rhumb line from the
origin Point with the (varant) given bearing.
- origin [Coord][2] starting point
- distance [number][3] distance from the starting point
- bearing [number][3] varant bearing angle ranging from -180 to 180 degrees from north
- options [Object][4] Optional parameters (optional, default {})
- options.units [string][5] can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
- options.properties [Object][4] translate properties to destination point (optional, default {})
``javascript
var pt = turf.point([-75.343, 39.984], {"marker-color": "F00"});
var distance = 50;
var bearing = 90;
var options = {units: 'miles'};
var destination = turf.rhumbDestination(pt, distance, bearing, options);
//addToMap
var addToMap = [pt, destination]
destination.properties['marker-color'] = '#00F';
`
Returns [Feature][6]<[Point][7]> Destination point.
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
[2]: https://tools.ietf.org/html/rfc7946#section-3.1.1
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[6]: https://tools.ietf.org/html/rfc7946#section-3.2
[7]: https://tools.ietf.org/html/rfc7946#section-3.1.2
---
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.
Install this module individually:
`sh`
$ npm install @spatial/rhumb-destination
Or install the Turf module that includes it as a function:
`sh``
$ npm install @turf/turf