7.2.0 • Published 7 months ago

@turf/hex-grid v7.2.0

Weekly downloads
102,707
License
MIT
Repository
github
Last release
7 months ago

@turf/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>? 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 @turf/hex-grid

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

$ npm install @turf/turf
7.2.0

7 months ago

7.1.0

11 months ago

7.1.0-alpha.70

11 months ago

7.0.0

1 year ago

7.1.0-alpha.7

1 year ago

7.0.0-alpha.116

1 year ago

7.0.0-alpha.115

1 year ago

7.0.0-alpha.114

1 year ago

7.0.0-alpha.113

1 year ago

7.0.0-alpha.111

1 year ago

7.0.0-alpha.110

2 years ago

7.0.0-alpha.1

2 years ago

7.0.0-alpha.2

2 years ago

7.0.0-alpha.0

3 years ago

6.5.0

4 years ago

6.4.0

4 years ago

6.3.0

4 years ago

6.2.0

5 years ago

6.2.0-alpha.3

5 years ago

6.2.0-alpha.2

5 years ago

6.2.0-alpha.0

5 years ago

6.2.0-alpha.1

5 years ago

6.0.2

7 years ago

6.0.1

7 years ago

6.0.0

7 years ago

5.1.5

8 years ago

5.1.0

8 years ago

5.0.5

8 years ago

5.0.4

8 years ago

5.0.1

8 years ago

5.0.0

8 years ago

4.7.3

8 years ago

4.7.1

8 years ago

4.7.0

8 years ago

4.6.1

8 years ago

4.6.0

8 years ago

4.5.2

8 years ago

4.5.1

8 years ago

4.4.0

8 years ago

4.3.1

8 years ago

4.3.0

8 years ago

4.2.0

8 years ago

4.1.0

8 years ago

4.0.2

8 years ago

4.0.1

8 years ago

4.0.0

8 years ago

3.14.0

8 years ago

3.13.0

8 years ago

3.11.7

8 years ago

3.10.5

8 years ago

3.10.4

8 years ago

3.10.3

8 years ago

3.10.2

8 years ago

3.10.0

8 years ago

3.7.5

8 years ago

3.7.3

9 years ago

3.7.2

9 years ago

3.7.1

9 years ago

3.7.0

9 years ago

3.6.3

9 years ago

3.6.1

9 years ago

3.5.3

9 years ago

3.5.2

9 years ago

3.3.3

9 years ago

3.1.2

9 years ago

3.1.1

9 years ago

3.0.16

9 years ago

3.0.15

9 years ago