@turf/along

turf along module

Usage no npm install needed!

<script type="module">
  import turfAlong from 'https://cdn.skypack.dev/@turf/along';
</script>

README

@turf/along

along

Takes a LineString and returns a Point at a specified distance along the line.

Parameters

  • line Feature<LineString> input line
  • distance number distance along the line
  • options Object? Optional parameters
    • options.units string can be degrees, radians, miles, or kilometers (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 module individually:

$ npm install @turf/along

Or install the Turf module that includes it as a function:

$ npm install @turf/turf