API.md

H3.API

!!! note descriptions are taken from - https://h3geo.org/docs/ - https://github.com/uber/h3/blob/master/src/h3lib/include/h3api.h.in

Indexing functions

latLngToCell
cellToLatLng
cellToBoundary

Index inspection functions

getResolution
getBaseCellNumber
stringToH3
h3ToString
isValidCell
isResClassIII
isPentagon

Grid traversal functions

gridDisk
maxGridDiskSize
gridDiskDistances
gridDiskUnsafe
gridDiskDistancesUnsafe
gridDisksUnsafe
gridRingUnsafe
gridPathCells
gridPathCellsSize
gridDistance
cellToLocalIj
localIjToCell

Hierarchical grid functions

cellToParent
cellToChildren
cellToChildrenSize
compactCells
uncompactCells
uncompactCellsSize

Unidirectional edge functions

areNeighborCells
cellsToDirectedEdge
isValidDirectedEdge
getDirectedEdgeOrigin
getDirectedEdgeDestination
directedEdgeToCells
originToDirectedEdges
directedEdgeToBoundary

Miscellaneous H3 functions

hexAreaKm2
hexAreaM2
cellAreaRads2
cellAreaKm2
cellAreaM2
edgeLengthKm
edgeLengthM
getNumCells
getRes0Cells
res0CellCount

Coordinate Systems

ijToIjk
ijkToHex2d
ijkToIj
ijkDistance
ijkNormalize
cellToLocalIjk
h3ToFaceIjk
localIjkToCell
faceIjkToH3
hex2dToCoordIJK
geoToVec3d
geoToFaceIjk