@turf/length

turf length module

Usage no npm install needed!

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

README

@turf/length

length

Takes a GeoJSON and measures its length in the specified units, (Multi)Point's distance are ignored.

Parameters

  • geojson Feature<(LineString | MultiLineString)> GeoJSON to measure
  • options Object Optional parameters (optional, default {})
    • options.units string can be degrees, radians, miles, or kilometers (optional, default kilometers)

Examples

var line = turf.lineString([[115, -32], [131, -22], [143, -25], [150, -34]]);
var length = turf.length(line, {units: 'miles'});

//addToMap
var addToMap = [line];
line.properties.distance = length;

Returns number length of GeoJSON

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/length

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

$ npm install @turf/turf