@turf/line-to-polygon

@turf/line-to-polygon

lineToPolygon

Converts (Multi)LineString(s) to Polygon(s).

Parameters

• lines (FeatureCollection | Feature<(LineString | MultiLineString)>) Features to convert

• options Object Optional parameters (optional, default {})

  • options.properties Object translates GeoJSON properties to Feature (optional, default {})
  • options.autoComplete boolean auto complete linestrings (matches first & last coordinates) (optional, default true)
  • options.orderCoords boolean sorts linestrings to place outer ring at the first position of the coordinates (optional, default true)
  • options.mutate boolean mutate the original linestring using autoComplete (matches first & last coordinates) (optional, default false)

Examples

var line = turf.lineString([[125, -30], [145, -30], [145, -20], [125, -20], [125, -30]]);

var polygon = turf.lineToPolygon(line);

//addToMap
var addToMap = [polygon];

Returns Feature<(Polygon | MultiPolygon)> converted to Polygons

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 single module individually:

$ npm install @turf/line-to-polygon

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf