@turf/along
TypeScript icon, indicating that this package has built-in type declarations

7.1.0 • Public • Published

@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 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

Package Sidebar

Install

npm i @turf/along

Weekly Downloads

585,481

Version

7.1.0

License

MIT

Unpacked Size

14.6 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly