Package Exports

@turf/line-chunk

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/line-chunk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/line-chunk

lineChunk

Divides a LineString into chunks of a specified length. If the line is shorter than the segment length then the original line is returned.

Parameters

featureIn (FeatureCollection | Feature<(LineString | MultiLineString)>) the lines to split
segmentLength number how long to make each segment
units [string] units can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
reverse [boolean] reverses coordinates to start the first chunked segment at the end (optional, default false)

Examples

var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [-95, 40],
      [-93, 45],
      [-85, 50]
    ]
  }
};
var result = turf.lineChunk(line, 15, 'miles');
//=result

Returns FeatureCollection<LineString> collection of line segments

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/line-chunk

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

$ npm install @turf/turf