3.0.12 • Published 8 years ago

turf-hex-grid v3.0.12

Weekly downloads
11,350
License
MIT
Repository
github
Last release
8 years ago

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

parametertypedescription
bboxArray.\<number>bounding box in minX, minY, maxX, maxY order
cellWidthNumberwidth of cell in specified units
unitsStringused 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