Version: 3.x

Miscellaneous H3 functions

These functions include descriptions of the H3 grid system.

degsToRads

C
Python
Java
JavaScript (Live)

double degsToRads(double degrees);

note

Use math.radians(degrees) instead.

note

Use java.lang.Math.toRadians(double degrees) instead.

h3.degsToRads(degrees)

Live Editor

function example() {
  const degrees = 45;
  return h3.degsToRads(degrees);
}

function example() {
  const degrees = 45;
  return h3.degsToRads(degrees);
}

Result

Converts degrees to radians.

radsToDegs

C
Python
Java
JavaScript (Live)

double radsToDegs(double radians);

note

Use math.degrees(radians) instead.

note

Use java.lang.Math.toDegrees(double radians) instead.

h3.radsToDegs(h)

Live Editor

function example() {
  const radians = 3.14159;
  return h3.radsToDegs(radians);
}

function example() {
  const radians = 3.14159;
  return h3.radsToDegs(radians);
}

Result

Converts radians to degrees.

hexAreaKm2

C
Python
Java
JavaScript (Live)

double hexAreaKm2(int res);

h3.hex_area(res, unit='km^2')

double hexArea(int res, AreaUnit unit);

h3.hexArea(res, h3.UNITS.km2)

Live Editor

function example() {
  const res = 5;
  return h3v3.hexArea(res, h3v3.UNITS.km2);
}

function example() {
  const res = 5;
  return h3v3.hexArea(res, h3v3.UNITS.km2);
}

Result

Average hexagon area in square kilometers at the given resolution.

hexAreaM2

C
Python
Java
JavaScript (Live)

double hexAreaM2(int res);

h3.hex_area(res, unit='m^2')

double hexArea(int res, AreaUnit unit);

h3.hexArea(res, h3.UNITS.m2)

Live Editor

function example() {
  const res = 5;
  return h3v3.hexArea(res, h3v3.UNITS.m2);
}

function example() {
  const res = 5;
  return h3v3.hexArea(res, h3v3.UNITS.m2);
}

Result

Average hexagon area in square meters at the given resolution.

cellAreaM2

C
Python
Java
JavaScript (Live)

double cellAreaM2(H3Index h);

h3.cell_area(h, unit='m^2')

double cellArea(long h3, AreaUnit unit);
int cellArea(String h3Address, AreaUnit unit);

h3.cellArea(h, h3.UNITS.m2)

Live Editor

function example() {
  const h = '85283473fffffff';
  return h3v3.cellArea(h, h3v3.UNITS.m2);
}

function example() {
  const h = '85283473fffffff';
  return h3v3.cellArea(h, h3v3.UNITS.m2);
}

Result

Exact area of specific cell in square meters.

cellAreaRads2

C
Python
Java
JavaScript (Live)

double cellAreaRads2(H3Index h);

h3.cell_area(h, unit='rads^2')

double cellArea(long h3, AreaUnit unit);
int cellArea(String h3Address, AreaUnit unit);

h3.cellArea(h, h3.UNITS.rads2)

Live Editor

function example() {
  const h = '85283473fffffff';
  return h3v3.cellArea(h, h3v3.UNITS.rads2);
}

function example() {
  const h = '85283473fffffff';
  return h3v3.cellArea(h, h3v3.UNITS.rads2);
}

Result

Exact area of specific cell in square radians.

edgeLengthKm

C
Python
Java
JavaScript (Live)

double edgeLengthKm(int res);

h3.edge_length(res, unit='km')

double edgeLength(int res, LengthUnit unit);

h3.edgeLength(res, h3.UNITS.km)

Live Editor

function example() {
  const res = 5;
  return h3v3.edgeLength(res, h3v3.UNITS.km);
}

function example() {
  const res = 5;
  return h3v3.edgeLength(res, h3v3.UNITS.km);
}

Result

Average hexagon edge length in kilometers at the given resolution.

edgeLengthM

C
Python
Java
JavaScript (Live)

double edgeLengthM(int res);

h3.edge_length(res, unit='m')

double edgeLength(int res, LengthUnit unit);

h3.edgeLength(res, h3.UNITS.m)

Live Editor

function example() {
  const res = 5;
  return h3v3.edgeLength(res, h3v3.UNITS.m);
}

function example() {
  const res = 5;
  return h3v3.edgeLength(res, h3v3.UNITS.m);
}

Result

Average hexagon edge length in meters at the given resolution.

exactEdgeLengthKm

C
Python
Java
JavaScript (Live)

double exactEdgeLengthKm(H3Index edge);

h3.exact_edge_length(h, unit='km')

double exactEdgeLength(long h3, LengthUnit unit);
double exactEdgeLength(String h3Address, LengthUnit unit);

h3.exactEdgeLength(h3, h3.UNITS.km)

Live Editor

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.km);
}

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.km);
}

Result

Exact edge length of specific unidirectional edge in kilometers.

exactEdgeLengthM

C
Python
Java
JavaScript (Live)

double exactEdgeLengthM(H3Index edge);

h3.exact_edge_length(h, unit='m')

double exactEdgeLength(long h3, LengthUnit unit);
double exactEdgeLength(String h3Address, LengthUnit unit);

h3.exactEdgeLength(h3, h3.UNITS.m)

Live Editor

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.m);
}

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.m);
}

Result

Exact edge length of specific unidirectional edge in meters.

exactEdgeLengthRads

C
Python
Java
JavaScript (Live)

double exactEdgeLengthRads(H3Index edge);

h3.exact_edge_length(h, unit='rads')

double exactEdgeLength(long h3, LengthUnit unit);
double exactEdgeLength(String h3Address, LengthUnit unit);

h3.exactEdgeLength(h3, h3.UNITS.rads)

Live Editor

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.rads);
}

function example() {
  const h = '115283473fffffff';
  return h3v3.exactEdgeLength(h, h3v3.UNITS.rads);
}

Result

Exact edge length of specific unidirectional edge in radians.

numHexagons

C
Python
Java
JavaScript (Live)

int64_t numHexagons(int res);

h3.num_hexagons(res)

long numHexagons(int res);

h3.numHexagons(res)

Live Editor

function example() {
  const res = 5;
  return h3v3.numHexagons(res);
}

function example() {
  const res = 5;
  return h3v3.numHexagons(res);
}

Result

Number of unique H3 indexes at the given resolution.

getRes0Indexes

C
Python
Java
JavaScript (Live)

void getRes0Indexes(H3Index *out);

h3.get_res0_indexes(res)

Collection<Long> getRes0Indexes(int res);
Collection<String> getRes0IndexesAddresses(int res);

h3.getRes0Indexes(res)

Live Editor

function example() {
  const res = 5;
  return h3v3.getRes0Indexes(res);
}

function example() {
  const res = 5;
  return h3v3.getRes0Indexes(res);
}

Result

All the resolution 0 H3 indexes. out must be an array of at least size res0IndexCount().

res0IndexCount

C
Python
Java
JavaScript (Live)

int res0IndexCount(void);

Number of resolution 0 H3 indexes.

getPentagonIndexes

C
Python
Java
JavaScript (Live)

void getPentagonIndexes(int res, H3Index *out);

h3.get_pentagon_indexes(res)

Collection<Long> getPentagonIndexes(int res);
Collection<String> getPentagonIndexesAddresses(int res);

h3.getPentagonIndexes(res)

Live Editor

function example() {
  const res = 5;
  return h3v3.getPentagonIndexes(res);
}

function example() {
  const res = 5;
  return h3v3.getPentagonIndexes(res);
}

Result

All the pentagon H3 indexes at the specified resolution. out must be an array of at least size pentagonIndexCount().

pentagonIndexCount

C
Python
Java
JavaScript (Live)

int pentagonIndexCount(void);

Number of pentagon H3 indexes per resolution. This is always 12, but provided as a convenience.

pointDistKm

C
Python
Java
JavaScript (Live)

double pointDistKm(const GeoCoord *a, const GeoCoord *b);

h3.point_dist(point1, point2, unit='km')

double pointDist(GeoCoord point1, GeoCoord point2, LengthUnit unit);

h3.pointDist(point1, point2, h3.UNITS.km)

Live Editor

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.km)
}

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.km)
}

Result

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in kilometers.

pointDistM

C
Python
Java
JavaScript (Live)

double pointDistM(const GeoCoord *a, const GeoCoord *b);

h3.point_dist(point1, point2, unit='m')

double pointDist(GeoCoord point1, GeoCoord point2, LengthUnit unit);

h3.pointDist(point1, point2, h3.UNITS.m)

Live Editor

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.m)
}

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.m)
}

Result

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in meters.

pointDistRads

C
Python
Java
JavaScript (Live)

double pointDistRads(const GeoCoord *a, const GeoCoord *b);

h3.point_dist(point1, point2, unit='rads')

double pointDist(GeoCoord point1, GeoCoord point2, LengthUnit unit);

h3.pointDist(point1, point2, h3.UNITS.rads)

Live Editor

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.rads)
}

function example() {
  const point1 = [-10, 0];
  const point2 = [10, 0];
  return h3v3.pointDist(point1, point2, h3v3.UNITS.rads)
}

Result

Gives the "great circle" or "haversine" distance between pairs of GeoCoord points (lat/lng pairs) in radians.

degsToRads​

radsToDegs​

hexAreaKm2​

hexAreaM2​

cellAreaM2​

cellAreaRads2​

edgeLengthKm​

edgeLengthM​

exactEdgeLengthKm​

exactEdgeLengthM​

exactEdgeLengthRads​

numHexagons​

getRes0Indexes​

res0IndexCount​

getPentagonIndexes​

pentagonIndexCount​

pointDistKm​

pointDistM​

pointDistRads​

degsToRads

radsToDegs

hexAreaKm2

hexAreaM2

cellAreaM2

cellAreaRads2

edgeLengthKm

edgeLengthM

exactEdgeLengthKm

exactEdgeLengthM

exactEdgeLengthRads

numHexagons

getRes0Indexes

res0IndexCount

getPentagonIndexes

pentagonIndexCount

pointDistKm

pointDistM

pointDistRads