@turf/bbox-polygon

turf bbox-polygon module

Usage no npm install needed!

<script type="module">
  import turfBboxPolygon from 'https://cdn.skypack.dev/@turf/bbox-polygon';
</script>

README

@turf/bbox-polygon

bboxPolygon

Takes a bbox and returns an equivalent polygon.

Parameters

  • bbox BBox extent in [minX, minY, maxX, maxY] order
  • options Object Optional parameters (optional, default {})
    • options.properties Properties Translate properties to Polygon (optional, default {})
    • options.id (string | number) Translate Id to Polygon (optional, default {})

Examples

var bbox = [0, 0, 10, 10];

var poly = turf.bboxPolygon(bbox);

//addToMap
var addToMap = [poly]

Returns Feature<Polygon> a Polygon representation of the bounding box


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/bbox-polygon

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

$ npm install @turf/turf