Indexing functions

These functions are used for finding the H3 cell index containing coordinates, and for finding the center and boundary of H3 indexes.

latLngToCell

C

H3Error latLngToCell(const LatLng *g, int res, H3Index *out);

Python

h3.latlng_to_cell(lat, lng, resolution)

Java

long latLngToCell(double lat, double lng, int res);
String latLngToCellAddress(double lat, double lng, int res);

JavaScript (Live)

h3.latLngToCell(lat, lng, res)

Live Editor

function example() { const lat = 45; const lng = 40; const res = 2; return h3.latLngToCell(lat, lng, res); }

function example() {
  const lat = 45;
  const lng = 40;
  const res = 2;
  return h3.latLngToCell(lat, lng, res);
}

Result

Loading...

Indexes the location at the specified resolution, returning the index of the cell containing the location. This buckets the geographic point into the H3 grid. See the algorithm description for more information.

Returns 0 (E_SUCCESS) on success.

cellToLatLng

C

H3Error cellToLatLng(H3Index cell, LatLng *g);

Python

h3.cell_to_latlng(cell)

Java

LatLng cellToLatLng(long cell);
LatLng cellToLatLng(String cellAddress);

JavaScript (Live)

h3.cellToLatLng(cell)

Live Editor

function example() { const cell = '85283473fffffff'; return h3.cellToLatLng(cell); }

function example() {
  const cell = '85283473fffffff';
  return h3.cellToLatLng(cell);
}

Result

Loading...

Finds the center of the cell in grid space. See the algorithm description for more information.

The center will drift versus the centroid of the cell on Earth due to distortion from the gnomonic projection within the icosahedron face it resides on and its distance from the center of the icosahedron face.

Returns 0 (E_SUCCESS) on success.

cellToBoundary

C

H3Error cellToBoundary(H3Index cell, CellBoundary *bndry);

Python

h3.cell_to_boundary(cell, geo_json=False)

Java

List<LatLng> cellToBoundary(long cell);
List<LatLng> cellToBoundary(String cellAddress);

JavaScript (Live)

h3.cellToBoundary(cell, [formatAsGeoJson])

Live Editor

function example() { const cell = '85283473fffffff'; return h3.cellToBoundary(cell); }

function example() {
  const cell = '85283473fffffff';
  return h3.cellToBoundary(cell);
}

Result

Loading...

Finds the boundary of the cell. See the algorithm description for more information.

Returns 0 (E_SUCCESS) on success.