Skip to content

Takes a Feature or FeatureCollection and returns a rectangular polygon feature that encompasses all vertices.

License

Notifications You must be signed in to change notification settings

turf-junkyard/turf-envelope

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

turf-envelope

build status

turf envelope module

turf.envelope(fc)

Takes any number of features and returns a rectangular Polygon that encompasses all vertices.

Parameters

parameter type description
fc FeatureCollection input features

Example

var fc = {
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "name": "Location A"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-75.343, 39.984]
      }
    }, {
      "type": "Feature",
      "properties": {
        "name": "Location B"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-75.833, 39.284]
      }
    }, {
      "type": "Feature",
      "properties": {
        "name": "Location C"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-75.534, 39.123]
      }
    }
  ]
};

var enveloped = turf.envelope(fc);

var resultFeatures = fc.features.concat(enveloped);
var result = {
  "type": "FeatureCollection",
  "features": resultFeatures
};

//=result

Returns Feature.<Polygon>, a rectangular Polygon feature that encompasses all vertices

Installation

Requires nodejs.

$ npm install turf-envelope

Tests

$ npm test

About

Takes a Feature or FeatureCollection and returns a rectangular polygon feature that encompasses all vertices.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •