Package Exports
- @turf/length
- @turf/length/package.json
Readme
@turf/length
length
Takes a GeoJSON and measures its length in the specified units, (Multi)Point's distance are ignored.
Parameters
geojsonFeature<(LineString | MultiLineString)> GeoJSON to measureoptionsObject Optional parameters (optional, default{})options.unitsUnits Supports all valid Turf Units. (optional, defaultkilometers)
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 single module individually:
$ npm install @turf/lengthOr install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf