Miscellaneous H3 functions

These functions include descriptions of the H3 grid system.

degsToRads

C

double degsToRads(double degrees);

Python

note

Use math.radians(degrees) instead.

Java

note

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

JavaScript (Live)

h3.degsToRads(degrees)

Live Editor

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

Result

Loading...

Converts degrees to radians.

radsToDegs

C

double radsToDegs(double radians);

Python

note

Use math.degrees(radians) instead.

Java

note

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

JavaScript (Live)

h3.radsToDegs(h)

Live Editor

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

Result

Loading...

Converts radians to degrees.

hexAreaKm2

C

double hexAreaKm2(int res);

Python

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

Java

double hexArea(int res, AreaUnit unit);

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Average hexagon area in square kilometers at the given resolution.

hexAreaM2

C

double hexAreaM2(int res);

Python

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

Java

double hexArea(int res, AreaUnit unit);

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Average hexagon area in square meters at the given resolution.

cellAreaM2

C

double cellAreaM2(H3Index h);

Python

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

Java

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

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Exact area of specific cell in square meters.

cellAreaRads2

C

double cellAreaRads2(H3Index h);

Python

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

Java

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

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Exact area of specific cell in square radians.

edgeLengthKm

C

double edgeLengthKm(int res);

Python

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

Java

double edgeLength(int res, LengthUnit unit);

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Average hexagon edge length in kilometers at the given resolution.

edgeLengthM

C

double edgeLengthM(int res);

Python

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

Java

double edgeLength(int res, LengthUnit unit);

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Average hexagon edge length in meters at the given resolution.

exactEdgeLengthKm

C

double exactEdgeLengthKm(H3Index edge);

Python

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

Java

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

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Exact edge length of specific unidirectional edge in kilometers.

exactEdgeLengthM

C

double exactEdgeLengthM(H3Index edge);

Python

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

Java

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

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Exact edge length of specific unidirectional edge in meters.

exactEdgeLengthRads

C

double exactEdgeLengthRads(H3Index edge);

Python

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

Java

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

JavaScript (Live)

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

Live Editor

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

Result

Loading...

Exact edge length of specific unidirectional edge in radians.

numHexagons

C

int64_t numHexagons(int res);

Python

h3.num_hexagons(res)

Java

long numHexagons(int res);

JavaScript (Live)

h3.numHexagons(res)

Live Editor

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

Result

Loading...

Number of unique H3 indexes at the given resolution.

getRes0Indexes

C

void getRes0Indexes(H3Index *out);

Python

h3.get_res0_indexes(res)

Java

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

JavaScript (Live)

h3.getRes0Indexes(res)

Live Editor

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

Result

Loading...

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

res0IndexCount

C

int res0IndexCount(void);

Python

note

This function exists for memory management and is not exposed.

Java

note

This function exists for memory management and is not exposed.

JavaScript (Live)

note

This function exists for memory management and is not exposed.

Number of resolution 0 H3 indexes.

getPentagonIndexes

C

void getPentagonIndexes(int res, H3Index *out);

Python

h3.get_pentagon_indexes(res)

Java

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

JavaScript (Live)

h3.getPentagonIndexes(res)

Live Editor

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

Result

Loading...

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

pentagonIndexCount

C

int pentagonIndexCount(void);

Python

note

This function exists for memory management and is not exposed.

Java

note

This function exists for memory management and is not exposed.

JavaScript (Live)

note

This function exists for memory management and is not exposed.

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

pointDistKm

C

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

Python

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

Java

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

JavaScript (Live)

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)
}

Result

Loading...

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

pointDistM

C

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

Python

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

Java

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

JavaScript (Live)

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)
}

Result

Loading...

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

pointDistRads

C

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

Python

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

Java

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

JavaScript (Live)

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)
}

Result

Loading...

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