12345678910111213141516171819202122 |
- import { Feature, LineString, Point, Units } from "@turf/helpers";
- /**
- * Takes a {@link LineString} and returns a {@link Point} at a specified distance along the line.
- *
- * @name along
- * @param {Feature<LineString>} line input line
- * @param {number} distance distance along the line
- * @param {Object} [options] Optional parameters
- * @param {string} [options.units="kilometers"] can be degrees, radians, miles, or kilometers
- * @returns {Feature<Point>} Point `distance` `units` along the line
- * @example
- * var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]]);
- * var options = {units: 'miles'};
- *
- * var along = turf.along(line, 200, options);
- *
- * //addToMap
- * var addToMap = [along, line]
- */
- export default function along(line: Feature<LineString> | LineString, distance: number, options?: {
- units?: Units;
- }): Feature<Point>;
|