turf-line-distance

turf-line-distance ---

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
turf-line-distance
313.0.128 years ago9 years agoMinified + gzip package size for turf-line-distance in KB

Readme

turf-line-distance
build status
turf-line-distance ---

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

Measures the length of a LineString in the specified units.

Parameters

| parameter | type | description | | --------------- | ---------- | --------------------------------------------------------- | | Line | LineString | to measure | | [units=miles] | String | optional: can be degrees, radians, miles, or kilometers |

Example

var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [
        -77.0316696166992,
        38.878605901789236
      ],
      [
        -77.02960968017578,
        38.88194668656296
      ],
      [
        -77.02033996582031,
        38.88408470638821
      ],
      [
        -77.02566146850586,
        38.885821800123196
      ],
      [
        -77.02188491821289,
        38.88956308852534
      ],
      [
        -77.01982498168944,
        38.89236892551996
      ]
    ]
  }
};

var length = turf.lineDistance(line, 'miles');
//=length

Installation

Requires nodejs.
$ npm install turf-line-distance

Tests

$ npm test