@turf/line-chunk

turf line-chunk module

Usage no npm install needed!

<script type="module">
  import turfLineChunk from 'https://cdn.skypack.dev/@turf/line-chunk';
</script>

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

  • geojson (FeatureCollection | Geometry | Feature<(LineString | MultiLineString)>) the lines to split
  • segmentLength number how long to make each segment
  • options Object Optional parameters (optional, default {})
    • options.units string units can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
    • options.reverse boolean reverses coordinates to start the first chunked segment at the end (optional, default false)

Examples

var line = turf.lineString([[-95, 40], [-93, 45], [-85, 50]]);

var chunk = turf.lineChunk(line, 15, {units: 'miles'});

//addToMap
var addToMap = [chunk];

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