Directed edge functions

Directed edges allow encoding the directed (that is, which cell is the origin and which is the destination can be determined) edge from one cell to a neighboring cell.

areNeighborCells

Determines whether or not the provided H3 cells are neighbors.

C

H3Error areNeighborCells(H3Index origin, H3Index destination, int *out);

out will be 1 if the indexes are neighbors, 0 otherwise.

Returns 0 (E_SUCCESS) on success.

Java

boolean areNeighborCells(long origin, long destination);
boolean areNeighborCells(String origin, String destination);

JavaScript (Live)

h3.areNeighborCells(origin, destination)

Live Editor

function example() { const origin = '85283473fffffff'; const destination = '85283477fffffff'; return h3.areNeighborCells(origin, destination); }

function example() {
  const origin = '85283473fffffff';
  const destination = '85283477fffffff';
  return h3.areNeighborCells(origin, destination);
}

Result

Loading...

Python

h3.are_neighbor_cells(origin, destination)

Shell

$ h3 areNeighborCells --help
h3: Determines if the provided H3 cells are neighbors (have a shared border)
H3 4.1.0

    areNeighborCells    Determines if the provided H3 cells are neighbors (have a shared border)
    -o, --origin <CELL> Required. Origin H3 Cell
    -d, --destination <CELL>    Required. Destination H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for true or false, 'numeric' for 1 or 0 (Default: json)

$ h3 areNeighborCells -o 85283473fffffff -d 85283477fffffff
true

cellsToDirectedEdge

Provides a directed edge H3 index based on the provided origin and destination.

C

H3Error cellsToDirectedEdge(H3Index origin, H3Index destination, H3Index *out);

Returns 0 (E_SUCCESS) on success.

Java

long cellsToDirectedEdge(long origin, long destination);
String cellsToDirectedEdge(String origin, String destination);

JavaScript (Live)

h3.cellsToDirectedEdge(h3Index)

Live Editor

function example() { const origin = '85283473fffffff'; const destination = '85283477fffffff'; return h3.cellsToDirectedEdge(origin, destination); }

function example() {
  const origin = '85283473fffffff';
  const destination = '85283477fffffff';
  return h3.cellsToDirectedEdge(origin, destination);
}

Result

Loading...

Python

h3.cells_to_directed_edge(origin, destination)

Shell

$ h3 cellsToDirectedEdge --help
h3: Converts neighboring cells into a directed edge index (or errors if they are not neighbors)
H3 4.1.0

    cellsToDirectedEdge Converts neighboring cells into a directed edge index (or errors if they are not neighbors)
    -o, --origin <CELL> Required. Origin H3 Cell
    -d, --destination <CELL>    Required. Destination H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for "CELL"\n, 'newline' for CELL\n (Default: json)

$ h3 cellsToDirectedEdge -o 85283473fffffff -d 85283477fffffff
"115283473fffffff"

isValidDirectedEdge

Determines if the provided H3Index is a valid unidirectional edge index.

C

int isValidDirectedEdge(H3Index edge);

Returns 1 if it is a unidirectional edge H3Index, otherwise 0.

Java

boolean isValidDirectedEdge(long edge);
boolean isValidDirectedEdge(String edgeAddress);

JavaScript (Live)

h3.isValidDirectedEdge(edge)

Live Editor

function example() { const edge = '115283473fffffff'; return h3.isValidDirectedEdge(edge); }

function example() {
  const edge = '115283473fffffff';
  return h3.isValidDirectedEdge(edge);
}

Result

Loading...

Python

h3.is_valid_directed_edge(edge)

Shell

$ h3 isValidDirectedEdge --help
h3: Checks if the provided H3 directed edge is actually valid
H3 4.1.0

    isValidDirectedEdge Checks if the provided H3 directed edge is actually valid
    -h, --help  Show this help message.
    -c, --cell <index>  Required. H3 Cell
    -f, --format <FMT>  'json' for true or false, 'numeric' for 1 or 0 (Default: json)

$ h3 isValidDirectedEdge -c 115283473fffffff
true

getDirectedEdgeOrigin

Provides the origin hexagon from the directed edge H3Index.

C

H3Error getDirectedEdgeOrigin(H3Index edge, H3Index *out);

Returns 0 (E_SUCCESS) on success.

Java

long getDirectedEdgeOrigin(long edge);
String getDirectedEdgeOrigin(String edgeAddress);

JavaScript (Live)

h3.getDirectedEdgeOrigin(h3Index)

Live Editor

function example() { const edge = '115283473fffffff'; return h3.getDirectedEdgeOrigin(edge); }

function example() {
  const edge = '115283473fffffff';
  return h3.getDirectedEdgeOrigin(edge);
}

Result

Loading...

Python

h3.get_directed_edge_origin(edge)

Shell

$ h3 getDirectedEdgeOrigin --help
h3: Returns the origin cell from the directed edge
H3 4.1.0

    getDirectedEdgeOrigin   Returns the origin cell from the directed edge
    -c, --cell <index>  Required. H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for "CELL"\n, 'newline' for CELL\n (Default: json)

$ h3 getDirectedEdgeOrigin -c 115283473fffffff
"85283473fffffff"

getDirectedEdgeDestination

Provides the destination hexagon from the directed edge H3Index.

C

H3Error getDirectedEdgeDestination(H3Index edge, H3Index *out);

Returns 0 (E_SUCCESS) on success.

Java

long getDirectedEdgeDestination(long edge);
String getDirectedEdgeDestination(String edgeAddress);

JavaScript (Live)

h3.getDirectedEdgeDestination(edge)

Live Editor

function example() { const edge = '115283473fffffff'; return h3.getDirectedEdgeDestination(edge); }

function example() {
  const edge = '115283473fffffff';
  return h3.getDirectedEdgeDestination(edge);
}

Result

Loading...

Python

h3.get_directed_edge_destination(edge)

Shell

$ h3 getDirectedEdgeDestination --help
h3: Returns the destination cell from the directed edge
H3 4.1.0

    getDirectedEdgeDestination  Returns the destination cell from the directed edge
    -c, --cell <index>  Required. H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for "CELL"\n, 'newline' for CELL\n (Default: json)

$ h3 getDirectedEdgeDestination -c 115283473fffffff
"85283477fffffff"

directedEdgeToCells

Provides the origin-destination pair of cells for the given directed edge.

C

H3Error directedEdgeToCells(H3Index edge, H3Index* originDestination);

The origin and destination are placed at originDestination[0] and originDestination[1], respectively.

Returns 0 (E_SUCCESS) on success.

Java

List<Long> directedEdgeToCells(long edge);
List<String> directedEdgeToCells(String edgeAddress);

JavaScript (Live)

h3.directedEdgeToCells(edge)

Live Editor

function example() { const edge = '115283473fffffff'; return h3.directedEdgeToCells(edge); }

function example() {
  const edge = '115283473fffffff';
  return h3.directedEdgeToCells(edge);
}

Result

Loading...

Python

h3.directed_edge_to_cells(edge)

Shell

$ h3 directedEdgeToCells --help
h3: Returns the origin, destination pair of cells from the directed edge
H3 4.1.0

    directedEdgeToCells Returns the origin, destination pair of cells from the directed edge
    -c, --cell <index>  Required. H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for ["CELL", ...], 'newline' for CELL\n... (Default: json)

$ h3 directedEdgeToCells -c 115283473fffffff
["85283473fffffff", "85283477fffffff"]

originToDirectedEdges

Provides all of the directed edges from the current cell.

C

H3Error originToDirectedEdges(H3Index origin, H3Index* edges);

edges must be of length 6, and the number of directed edges placed in the array may be less than 6. If this is the case, one of the members of the array will be 0.

Returns 0 (E_SUCCESS) on success.

Java

List<Long> originToDirectedEdges(long h3);
List<String> originToDirectedEdges(String h3);

JavaScript (Live)

h3.originToDirectedEdges(h3Index)

Live Editor

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

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

Result

Loading...

Python

h3.origin_to_directed_edges(h)

Shell

$ h3 originToDirectedEdges --help
h3: Returns all of the directed edges from the specified origin cell
H3 4.1.0

    originToDirectedEdges   Returns all of the directed edges from the specified origin cell
    -c, --cell <index>  Required. H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for ["CELL", ...], 'newline' for CELL\n... (Default: json)

$ h3 originToDirectedEdges -c 85283473fffffff
["115283473fffffff", "125283473fffffff", "135283473fffffff", "145283473fffffff", "155283473fffffff", "165283473fffffff"]

directedEdgeToBoundary

Provides the geographic lat/lng coordinates defining the directed edge. Note that this may be more than two points for complex edges.

C

H3Error directedEdgeToBoundary(H3Index edge, CellBoundary* gb);

Returns 0 (E_SUCCESS) on success.

Java

List<LatLng> directedEdgeToBoundary(long edge);
List<LatLng> directedEdgeToBoundary(String edgeAddress);

JavaScript (Live)

h3.directedEdgeToBoundary(edge, [formatAsGeoJson])

Live Editor

function example() { const edge = '115283473fffffff'; return h3.directedEdgeToBoundary(edge); }

function example() {
  const edge = '115283473fffffff';
  return h3.directedEdgeToBoundary(edge);
}

Result

Loading...

Python

h3.directed_edge_to_boundary(edge)

Shell

$ h3 directedEdgeToBoundary --help
h3: Provides the coordinates defining the directed edge
H3 4.1.0

    directedEdgeToBoundary  Provides the coordinates defining the directed edge
    -c, --cell <index>  Required. H3 Cell
    -h, --help  Show this help message.
    -f, --format <FMT>  'json' for [[lat, lng], ...], 'wkt' for a WKT POLYGON, 'newline' for lat\nlng\n... (Default: json)

$ h3 directedEdgeToBoundary -c 115283473fffffff
[[37.4201286777, -122.0377349643], [37.3375560844, -122.0904289290]]