@turf/buffer

@turf/buffer

buffer

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

When using a negative radius, the resulting geometry may be invalid if it's too small compared to the radius magnitude. If the input is a FeatureCollection, only valid members will be returned in the output FeatureCollection - i.e., the output collection may have fewer members than the input, or even be empty.

Parameters

• geojson (FeatureCollection | Geometry | Feature<any>) input to be buffered

• radius number distance to draw the buffer (negative values are allowed)

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

  • options.units string any of the options supported by turf units (optional, default "kilometers")
  • options.steps number number of steps (optional, default 8)

Examples

var point = turf.point([-90.548630, 14.616599]);
var buffered = turf.buffer(point, 500, {units: 'miles'});

//addToMap
var addToMap = [point, buffered]

Returns (FeatureCollection | Feature<(Polygon | MultiPolygon)> | undefined) 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 single module individually:

$ npm install @turf/buffer

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

$ npm install @turf/turf

Similar packages

Other packages similar to @turf/buffer

jsts

JSTS (JavaScript Topology Suite) is a JavaScript library for performing various spatial operations, including buffering. It is more comprehensive than @turf/buffer and includes a wide range of geometric operations, but it is also more complex to use.

geolib

Geolib is a library for geospatial calculations in JavaScript. While it does not offer as many features as @turf/buffer, it provides basic functionalities like distance calculations and bounding boxes, which can be useful for simpler tasks.

leaflet

Leaflet is a popular open-source JavaScript library for interactive maps. While it is primarily used for map rendering, it also includes some spatial analysis features, including buffering, through various plugins. It is more focused on visualization than @turf/buffer.