Index inspection functions

These functions provide metadata about an H3 index, such as its resolution or base cell, and provide utilities for converting into and out of the 64-bit representation of an H3 index.

getResolution

C

int getResolution(H3Index h);

Python

h3.get_resolution(h)

Java

int getResolution(long h3);
int getResolution(String h3Address);

JavaScript (Live)

h3.getResolution(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.getResolution(h); }

function example() {
  const h = '85283473fffffff';
  return h3.getResolution(h);
}

Result

Loading...

Returns the resolution of the index.

getBaseCellNumber

C

int getBaseCellNumber(H3Index h);

Python

h3.get_base_cell_number(h)

Java

int getBaseCellNumber(long h3);
int getBaseCellNumber(String h3Address);

JavaScript (Live)

h3.getBaseCellNumber(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.getBaseCellNumber(h); }

function example() {
  const h = '85283473fffffff';
  return h3.getBaseCellNumber(h);
}

Result

Loading...

Returns the base cell number of the index.

stringToH3

C

H3Error stringToH3(const char *str, H3Index *out);

Python

h3.string_to_h3(h)

Java

long stringToH3(String h3Address);

JavaScript (Live)

The H3 JavaScript binding supports only the string representation of an H3 index.

Converts the string representation to H3Index (uint64_t) representation.

Returns 0 (E_SUCCESS) on success.

h3ToString

C

H3Error h3ToString(H3Index h, char *str, size_t sz);

Python

h3.h3_to_string(h)

Java

String h3ToString(long h3);

JavaScript (Live)

The H3 JavaScript binding supports only the string representation of an H3 index.

Converts the H3Index representation of the index to the string representation. str must be at least of length 17.

Returns 0 (E_SUCCESS) on success.

isValidCell

C

int isValidCell(H3Index h);

Python

h3.is_valid_cell(h)

Java

boolean isValidCell(long h3);
boolean isValidCell(String h3Address);

JavaScript (Live)

h3.isValidCell(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.isValidCell(h); }

function example() {
  const h = '85283473fffffff';
  return h3.isValidCell(h);
}

Result

Loading...

Returns non-zero if this is a valid H3 cell index.

isResClassIII

C

int isResClassIII(H3Index h);

Python

h3.is_res_class_III(h)

Java

boolean isResClassIII(long h3);
boolean isResClassIII(String h3Address);

JavaScript (Live)

h3.isResClassIII(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.isResClassIII(h); }

function example() {
  const h = '85283473fffffff';
  return h3.isResClassIII(h);
}

Result

Loading...

Returns non-zero if this index has a resolution with Class III orientation.

isPentagon

C

int isPentagon(H3Index h);

Python

h3.is_pentagon(h)

Java

boolean isPentagon(long h3);
boolean isPentagon(String h3Address);

JavaScript (Live)

h3.isPentagon(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.isPentagon(h); }

function example() {
  const h = '85283473fffffff';
  return h3.isPentagon(h);
}

Result

Loading...

Returns non-zero if this index represents a pentagonal cell.

getIcosahedronFaces

C

H3Error getIcosahedronFaces(H3Index h, int* out);

Python

h3.get_icosahedron_faces(h)

Java

Collection<Integer> getIcosahedronFaces(long h3);
Collection<Integer> getIcosahedronFaces(String h3Address);

JavaScript (Live)

h3.getIcosahedronFaces(h)

Live Editor

function example() { const h = '85283473fffffff'; return h3.getIcosahedronFaces(h); }

function example() {
  const h = '85283473fffffff';
  return h3.getIcosahedronFaces(h);
}

Result

Loading...

Find all icosahedron faces intersected by a given H3 index and places them in the array out. out must be at least length of maxFaceCount(h).

Faces are represented as integers from 0-19, inclusive. The array is sparse, and empty (no intersection) array values are represented by -1.

Returns 0 (E_SUCCESS) on success.

maxFaceCount

C

H3Error maxFaceCount(H3Index h3, int *out);

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.

Returns the maximum number of icosahedron faces the given H3 index may intersect.