James Beard b7f1b4eafb v7.3.1
2025-11-27 17:43:27 +11:00
..
2025-05-16 08:59:12 +02:00
2017-03-05 23:40:09 -05:00
2025-11-27 17:43:27 +11:00
2025-05-16 08:59:12 +02: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

  • distance number distance along the line

  • options Object? Optional parameters (optional, default {})

    • options.units Units 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