Skip to content

turf-junkyard/turf-along

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

turf-along

build status

turf.along(line, distance, [units=miles])

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

Parameters

parameter type description
line Feature.<LineString> input line
distance Number distance along the line
[units=miles] String optional: can be degrees, radians, miles, or kilometers

Example

var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [-77.031669, 38.878605],
      [-77.029609, 38.881946],
      [-77.020339, 38.884084],
      [-77.025661, 38.885821],
      [-77.021884, 38.889563],
      [-77.019824, 38.892368]
    ]
  }
};

var along = turf.along(line, 1, 'miles');

var result = {
  "type": "FeatureCollection",
  "features": [line, along]
};

//=result

Returns Feature.<Point>, Point distance units along the line

Installation

Requires nodejs.

$ npm install turf-along

Tests

$ npm test

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published