JSPM

  • Created
  • Published
  • Downloads 880082
  • Score
    100M100P100Q282079F
  • License MIT

turf convex module

Package Exports

  • @turf/convex
  • @turf/convex/package.json

Readme

@turf/convex

convex

Takes a Feature or a FeatureCollection and returns a convex hull Polygon.

Internally this uses the convex-hull module that implements a monotone chain hull.

Parameters

  • geojson GeoJSON input Feature or FeatureCollection

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

    • options.concavity number 1 - thin shape. Infinity - convex hull. (optional, default Infinity)
    • options.properties Object Translate Properties to Feature (optional, default {})

Examples

var points = turf.featureCollection([
  turf.point([10.195312, 43.755225]),
  turf.point([10.404052, 43.8424511]),
  turf.point([10.579833, 43.659924]),
  turf.point([10.360107, 43.516688]),
  turf.point([10.14038, 43.588348]),
  turf.point([10.195312, 43.755225])
]);

var hull = turf.convex(points);

//addToMap
var addToMap = [points, hull]

Returns Feature<Polygon> a convex hull


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/convex

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

$ npm install @turf/turf