21 lines
862 B
TypeScript
Executable File
21 lines
862 B
TypeScript
Executable File
import { Feature, FeatureCollection, GeometryCollection, Units } from "@turf/helpers";
|
|
/**
|
|
* Takes a {@link GeoJSON} and measures its length in the specified units, {@link (Multi)Point}'s distance are ignored.
|
|
*
|
|
* @name length
|
|
* @param {Feature<LineString|MultiLineString>} geojson GeoJSON to measure
|
|
* @param {Object} [options={}] Optional parameters
|
|
* @param {string} [options.units=kilometers] can be degrees, radians, miles, or kilometers
|
|
* @returns {number} length of GeoJSON
|
|
* @example
|
|
* 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;
|
|
*/
|
|
export default function length(geojson: Feature<any> | FeatureCollection<any> | GeometryCollection, options?: {
|
|
units?: Units;
|
|
}): number;
|