Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

turf-hex

Turfjs24MIT1.0.2

turf hex module

turf, grid, hex, hexbin, points, geojson

readme

turf-hex

build status

turf hex module

turf.hex(bbox, size)

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
size Number size of cells in degrees

Example

var bbox = [7.2669410, 43.695307, 7.2862529, 43.706476];
var size = 0.001;

var hexgrid = turf.hex(bbox, size);

//=hexgrid

Installation

Requires nodejs.

$ npm install turf-hex

Tests

$ npm test