Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

turf-linestring

Turfjs5.8kMIT1.0.2

turf lineString module

linestring, line, gis, geojson, turf

readme

turf-linestring

build status

turf lineString module

turf.linestring(coordinates, properties)

Creates a LineString Feature based on a coordinate array. Properties can be added optionally.

Parameters

parameter type description
coordinates Array.<Array.<Number>> - an array of Positions
properties Object an Object consisting of key-value pairs to add as properties

Example

var linestring1 = turf.linestring([
    [-21.964416, 64.148203],
    [-21.956176, 64.141316],
    [-21.93901, 64.135924],
    [-21.927337, 64.136673]
]);
var linestring2 = turf.linestring([
    [-21.929054, 64.127985],
    [-21.912918, 64.134726],
    [-21.916007, 64.141016],
    [-21.930084, 64.14446]
], {name: 'line 1', distance: 145});

//=linestring1

//=linestring2

Installation

Requires nodejs.

$ npm install turf-linestring

Tests

$ npm test