H3Net Api

H3Net Primary Data Types

There are a large amount of data types available within the H3Net library, but these are the primary ones you'll be using.

• H3Index
• CoordIj
• GeoBoundary
• GeoCoord
• GeoPolygon
• LinkedGeoPolygon

H3Index

This is the primary data type that is used for mapping space on the globe.

It currently has two modes, cell or edge.

• When in cell mode, it indicates that it is a hexagon or pentagon that covers a set amount of space on the globe.
• When in edge mode, it indicates a directed edge that goes from one cell to another cell.

Learn more

CoordIj

This is a way of mapping out hexagon cells on a plane.

Since it's currently only being used within some experimental functions, it might be better to read how it looks by reviewing this page and scrolling down to "Axial coodinates".

Learn more

GeoBoundary

A Geoboundary is a data structure that defines a shape with each vertex being a GeoCoord, each measured in radians, rather than degrees.

It has a property named NumVerts that tells how many vetices there are. The other property is named Verts which is a List<GeoCoord> containing the location of each vertex.

Currently, there is not bounds checking on Verts, so use NUmVerts as your guideline when looking for each vertex.

Learn more

GeoCoord

A GeoCoord is a point on the sphere mapping a Latitude and a Longitude, measured in readians, so Latitude will have a range of +/- π/2 and a longitude of +/- π

There is a way to get the Latitude and Longitude in degrees, but that's not the default storage method.

Learn more

GeoPolygon

A GeoPolygon is a basic shape that may have holes in it that's used to map out where H3Index cells may be placed using polyfill.

If you wanted all the hexagons covering the land in FLorida, you'd have a GeoPolygon of the border of Florida, with lakes being the holes. The resulting polyfill would only have H3Index cells over the land only.

Learn more

LinkedGeoPolygon

LinkedGeoPolygons are pure evil. Like in that movie Time Bandits. You really don't want to know more at this time.

Learn more