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

Package detail

turf-hex-grid

Turfjs73.8kMITdeprecated3.0.12

Turf packages are now namespaced: please use @turf/hex-grid instead

hexGrid

turf, grid, hexgrid, hexbin, points, geojson

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