Package Exports

@spatial/hex-grid

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@spatial/hex-grid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@spatial/hex-grid

hexGrid

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

Parameters

bbox BBox extent in [minX, minY, maxX, maxY] order
cellSide number length of the side of the the hexagons or triangles, in units. It will also coincide with the radius of the circumcircle of the hexagons.
options Object Optional parameters (optional, default {})
- options.units string used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
- options.properties Object passed to each hexagon or triangle of the grid (optional, default {})
- options.mask Feature<(Polygon | MultiPolygon)>? if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
- options.triangles boolean whether to return as triangles instead of hexagons (optional, default false)

Examples

var bbox = [-96,31,-84,40];
var cellSide = 50;
var options = {units: 'miles'};

var hexgrid = turf.hexGrid(bbox, cellSide, options);

//addToMap
var addToMap = [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 @spatial/hex-grid

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

$ npm install @turf/turf