hexGrid
Description
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
| Name | Type | Description |
|---|---|---|
| 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 (default {}) |
| options.units? | string | used in calculating cell size, can be degrees, radians, miles, or kilometers (default 'kilometers') |
| options.properties? | Object | passed to each hexagon or triangle of the grid (default {}) |
| options.mask? | Feature<Polygon> | 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 (default false) |
Returns
FeatureCollection<Polygon> a hexagonal grid
Examples
var bbox = [-96, 31, -84, 40];
var cellSide = 50;
var options = { units: "miles" };
var hexgrid = turf.hexGrid(bbox, cellSide, options);
Installation
$ npm install @turf/hex-grid
import { hexGrid } from "@turf/hex-grid";
const result = hexGrid(...);
$ npm install @turf/turf
import * as turf from "@turf/turf";
const result = turf.hexGrid(...);