turf-hex-griddeprecated

# hexGrid

Usage no npm install needed!

<script type="module">
  import turfHexGrid from 'https://cdn.skypack.dev/turf-hex-grid';
</script>

README

turf-hex-grid

build status

turf.hex-grid(bbox, cellWidth, units)

Takes a bounding box and a cell size in degrees and returns a FeatureCollection of flat-topped hexagons (Polygon features) aligned in an "odd-q" vertical grid as described in Hexagonal Grids

Parameters

parameter type description
bbox Array.<number> bounding box in [minX, minY, maxX, maxY] order
cellWidth Number width of cell in specified units
units String used in calculating cellWidth ('miles' or 'kilometers')

Example

var bbox = [-96,31,-84,40];
var cellWidth = 50;
var units = 'miles';

var hexgrid = turf.hexGrid(bbox, cellWidth, units);

//=hexgrid

Returns FeatureCollection, units used in calculating cellWidth ('miles' or 'kilometers')

Installation

Requires nodejs.

$ npm install turf-hex-grid

Tests

$ npm test