Installations

npm install @spatial/hex-grid

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.16.0

NPM Version

lerna/3.16.4/node@v10.16.0+x64 (linux)

Pull Requests

Open

43

Total

1,074

Closed

184

Merged

847

Issues

Open

238

Total

1,759

Closed

1,521

Releases

14

v7.2.0

Updated on Dec 30, 2024

v7.1.0

Updated on Aug 09, 2024

v7.0.0

Updated on Jun 07, 2024

v6.5.0

Updated on Jun 14, 2024

v3.0.11

Updated on Jun 17, 2016

v3.0.4

Updated on Jun 13, 2016

View All 14 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (86.94%)

JavaScript (13.05%)

Shell (0.01%)

Developer

Turfjs

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

9,841 Stars

3,791 Commits

981 Forks

179 Watchers

48 Branches

177 Contributors

Updated on Jul 14, 2025

Maintainers

1

View All 177 Contributors

Package Meta Information

Latest Version

1.0.5

Package Id

@spatial/hex-grid@1.0.5

Unpacked Size

27.48 kB

Size

4.87 kB

File Count

7

NPM Version

lerna/3.16.4/node@v10.16.0+x64 (linux)

Node Version

10.16.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

4

@spatial/distance @spatial/helpers @spatial/intersect @spatial/invariant

Dev Dependencies

6

@spatial/bbox-polygon @spatial/truncate benchmark esm rollup tape

@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

1var bbox = [-96,31,-84,40];
2var cellSide = 50;
3var options = {units: 'miles'};
4
5var hexgrid = turf.hexGrid(bbox, cellSide, options);
6
7//addToMap
8var 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:

1$ npm install @spatial/hex-grid

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

1$ npm install @turf/turf

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Fuzzing

Determines if the project uses fuzzing.

10

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

Score

7.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More