@turf/line-offset

turf line-offset module

Usage no npm install needed!

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

README

@turf/line-offset

lineOffset

Takes a line and returns a line at offset by the specified distance.

Parameters

  • geojson (Geometry | Feature<(LineString | MultiLineString)>) input GeoJSON
  • distance number distance to offset the line (can be of negative value)
  • options Object Optional parameters (optional, default {})
    • options.units string can be degrees, radians, miles, kilometers, inches, yards, meters (optional, default 'kilometers')

Examples

var line = turf.lineString([[-83, 30], [-84, 36], [-78, 41]], { "stroke": "#F00" });

var offsetLine = turf.lineOffset(line, 2, {units: 'miles'});

//addToMap
var addToMap = [offsetLine, line]
offsetLine.properties.stroke = "#00F"

Returns Feature<(LineString | MultiLineString)> Line offset from the input line

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

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

$ npm install @turf/turf