mirror of
https://github.com/Turfjs/turf.git
synced 2026-01-25 16:07:00 +00:00
@turf/along
along
Takes a LineString and returns a Point at a specified distance along the line.
Parameters
-
line(Feature<LineString> | LineString) input line -
distancenumber distance along the line -
optionsObject? Optional parameters (optional, default{})options.unitsUnits Supports all valid Turf Units. (optional, default"kilometers")
Examples
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]
Returns Feature<Point> Point distance units along the line
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.
Installation
Install this single module individually:
$ npm install @turf/along
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf