31 lines
1.3 KiB
TypeScript
Executable File
31 lines
1.3 KiB
TypeScript
Executable File
import { Coord, Feature, Point, Properties, Units } from "@turf/helpers";
|
|
/**
|
|
* Returns the destination {@link Point} having travelled the given distance along a Rhumb line from the
|
|
* origin Point with the (varant) given bearing.
|
|
*
|
|
* @name rhumbDestination
|
|
* @param {Coord} origin starting point
|
|
* @param {number} distance distance from the starting point
|
|
* @param {number} bearing varant bearing angle ranging from -180 to 180 degrees from north
|
|
* @param {Object} [options={}] Optional parameters
|
|
* @param {string} [options.units='kilometers'] can be degrees, radians, miles, or kilometers
|
|
* @param {Object} [options.properties={}] translate properties to destination point
|
|
* @returns {Feature<Point>} Destination point.
|
|
* @example
|
|
* 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';
|
|
*/
|
|
declare function rhumbDestination<P = Properties>(origin: Coord, distance: number, bearing: number, options?: {
|
|
units?: Units;
|
|
properties?: P;
|
|
}): Feature<Point, P>;
|
|
export default rhumbDestination;
|