npm.io
3.0.12 • Published 10 years ago

turf-buffer

Licence
MIT
Version
3.0.12
Deps
4
Vulns
0
Weekly
0
Stars
23
DeprecatedThis package is deprecated

turf-buffer

buffer

Calculates a buffer for input features for a given radius. Units supported are miles, kilometers, and degrees.

Parameters

  • feature (Feature | FeatureCollection) input to be buffered
  • distance number distance to draw the buffer
  • unit string any of the options supported by turf units

Examples

var pt = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Point",
    "coordinates": [-90.548630, 14.616599]
  }
};
var unit = 'miles';

var buffered = turf.buffer(pt, 500, unit);
var result = turf.featurecollection([buffered, pt]);

//=result

Returns (FeatureCollection<Polygon> | FeatureCollection<MultiPolygon> | Polygon | MultiPolygon) buffered features


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

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

$ npm install turf

Keywords