12345678910111213141516171819202122 |
- import { Coord } from "@turf/helpers";
- /**
- * Finds the angle formed by two adjacent segments defined by 3 points. The result will be the (positive clockwise)
- * angle with origin on the `startPoint-midPoint` segment, or its explementary angle if required.
- *
- * @name angle
- * @param {Coord} startPoint Start Point Coordinates
- * @param {Coord} midPoint Mid Point Coordinates
- * @param {Coord} endPoint End Point Coordinates
- * @param {Object} [options={}] Optional parameters
- * @param {boolean} [options.explementary=false] Returns the explementary angle instead (360 - angle)
- * @param {boolean} [options.mercator=false] if calculations should be performed over Mercator or WGS84 projection
- * @returns {number} Angle between the provided points, or its explementary.
- * @example
- * turf.angle([5, 5], [5, 6], [3, 4]);
- * //=45
- */
- declare function angle(startPoint: Coord, midPoint: Coord, endPoint: Coord, options?: {
- explementary?: boolean;
- mercator?: boolean;
- }): number;
- export default angle;
|