@turf/line-distance

@turf/line-distance

lineDistance

Takes a LineString or Polygon and measures its length in the specified units.

Parameters

• geojson (Feature<(LineString | Polygon)> | FeatureCollection<(LineString | Polygon)>) feature to measure
• units [string] can be degrees, radians, miles, or kilometers (optional, default kilometers)

Examples

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 length = turf.lineDistance(line, 'miles');

//=line

//=length

Returns number length feature

---

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/line-distance

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

$ npm install @turf/turf

Changelog

4.1.0

New Modules

• @turf/line-arc
• @turf/polygon-to-linestring
• @turf/bbox-clip
• @turf/line-overlap

Enhancements

• added centered param to point-grid (PR: https://github.com/Turfjs/turf/pull/650)
• Single module.export helpers, invariant & meta (Commit: https://github.com/Turfjs/turf/commit/9cebb2100cf545fec49488c80140909ab54358b5)

Bug Fixes

• Turf.invariant fails on string value as coordinate (PR: https://github.com/Turfjs/turf/pull/643)
• Handle precision=0 turf-truncate (PR: https://github.com/Turfjs/turf/pull/641)
• Added radiansToDistance, distanceToRadians & distanceToDegrees to Turf core library from @turf/helpers. (Commit: https://github.com/Turfjs/turf/commit/a88d77a3e7f76860b3c138a716da8b603a407c8e)
• Removed process.hrtime in @turf/polygon-unkink(issue: https://github.com/mclaeysb/simplepolygon/issues/5)