30 lines
1.1 KiB
TypeScript
Executable File
30 lines
1.1 KiB
TypeScript
Executable File
import { Coord, Feature, LineString, Units } from "@turf/helpers";
|
|
/**
|
|
* Creates a circular arc, of a circle of the given radius and center point, between bearing1 and bearing2;
|
|
* 0 bearing is North of center point, positive clockwise.
|
|
*
|
|
* @name lineArc
|
|
* @param {Coord} center center point
|
|
* @param {number} radius radius of the circle
|
|
* @param {number} bearing1 angle, in decimal degrees, of the first radius of the arc
|
|
* @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc
|
|
* @param {Object} [options={}] Optional parameters
|
|
* @param {number} [options.steps=64] number of steps
|
|
* @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians
|
|
* @returns {Feature<LineString>} line arc
|
|
* @example
|
|
* var center = turf.point([-75, 40]);
|
|
* var radius = 5;
|
|
* var bearing1 = 25;
|
|
* var bearing2 = 47;
|
|
*
|
|
* var arc = turf.lineArc(center, radius, bearing1, bearing2);
|
|
*
|
|
* //addToMap
|
|
* var addToMap = [center, arc]
|
|
*/
|
|
export default function lineArc(center: Coord, radius: number, bearing1: number, bearing2: number, options?: {
|
|
steps?: number;
|
|
units?: Units;
|
|
}): Feature<LineString>;
|