Package Exports

@turf/line-split

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-split) 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-split

lineSplit

Split a LineString by another GeoJSON Feature.

Parameters

line Feature<LineString> LineString Feature to split
splitter Feature<(Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon)> Feature used to split line

Examples

var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [[120, -25], [145, -25]]
  }
};
var splitter = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [[130, -15], [130, -35]]
  }
};
var split = turf.lineSplit(line, splitter);
//=split

Returns FeatureCollection<LineString> Split LineStrings

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-split

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

$ npm install @turf/turf