@turf/hex-grid

hexGrid

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

bbox Array<number> extent in [minX, minY, maxX, maxY] order
cellSize number dimension of cell in specified units
units [string] used in calculating cellSize, can be degrees, radians, miles, or kilometers (optional, default kilometers)
triangles [boolean] whether to return as triangles instead of hexagons (optional, default false)

Examples

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

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

//=hexgrid

Returns FeatureCollection<Polygon> a hexagonal grid

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/hex-grid

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

$ npm install @turf/turf

2.2 KiB Raw Blame History

@turf/hex-grid

hexGrid

Installation

2.2 KiB

Raw Blame History