Region functions

These functions convert H3 indexes to and from polygonal areas.

polygonToCells

C

H3Error polygonToCells(const GeoPolygon *geoPolygon, int res, uint32_t flags, H3Index *out);

Python

h3.polygon_to_cells(polygons, res, geo_json_conformant=False)

Java

List<Long> polygonToCells(List<LatLng> points, List<List<LatLng>> holes, int res);
List<String> polygonToCellAddresses(List<LatLng> points, List<List<LatLng>> holes, int res);

JavaScript (Live)

h3.polygonToCells(polygon, res, isGeoJson)

Live Editor

function example() { const polygon = [ [37.813318999983238, -122.4089866999972145], [37.7198061999978478, -122.3544736999993603], [37.8151571999998453, -122.4798767000009008] ]; const res = 7; return h3.polygonToCells(polygon, res); }

function example() {
    const polygon = [
        [37.813318999983238, -122.4089866999972145],
        [37.7198061999978478, -122.3544736999993603],
        [37.8151571999998453, -122.4798767000009008]
    ];
    const res = 7;
    return h3.polygonToCells(polygon, res);
}

Result

Loading...

polygonToCells takes a given GeoJSON-like data structure and preallocated, zeroed memory, and fills it with the hexagons that are contained by the GeoJSON-like data structure.

Containment is determined by the cells' centroids. A partitioning using the GeoJSON-like data structure, where polygons cover an area without overlap, will result in a partitioning in the H3 grid, where cells cover the same area without overlap.

Returns 0 (E_SUCCESS) on success.

maxPolygonToCellsSize

C

H3Error maxPolygonToCellsSize(const GeoPolygon *geoPolygon, int res, uint32_t flags, int64_t *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.

maxPolygonToCellsSize returns the number of hexagons to allocate space for when computing polygonToCells on the given GeoJSON-like data structure.

Returns 0 (E_SUCCESS) on success.

cellsToLinkedMultiPolygon / cellsToMultiPolygon

C

H3Error cellsToLinkedMultiPolygon(const H3Index *h3Set, const int numHexes, LinkedGeoPolygon *out);

Python

h3.cells_to_multi_polygon(hexes, geo_json=False)

Java

List<List<List<LatLng>>> cellsToMultiPolygon(Collection<Long> h3, boolean geoJson);
List<List<List<LatLng>>> cellAddressesToMultiPolygon(Collection<String> h3Addresses, boolean geoJson);

JavaScript (Live)

h3.cellsToMultiPolygon(cells, geoJson)

Live Editor

function example() { const hexagons = ['872830828ffffff', '87283082effffff']; return h3.cellsToMultiPolygon(hexagons, true); }

function example() {
    const hexagons = ['872830828ffffff', '87283082effffff'];
    return h3.cellsToMultiPolygon(hexagons, true);
}

Result

Loading...

Create a LinkedGeoPolygon describing the outline(s) of a set of hexagons. Polygon outlines will follow GeoJSON MultiPolygon order: Each polygon will have one outer loop, which is first in the list, followed by any holes.

It is the responsibility of the caller to call destroyLinkedPolygon on the populated linked geo structure, or the memory for that structure will not be freed.

It is expected that all hexagons in the set have the same resolution and that the set contains no duplicates. Behavior is undefined if duplicates or multiple resolutions are present, and the algorithm may produce unexpected or invalid output.

Returns 0 (E_SUCCESS) on success.

destroyLinkedMultiPolygon

C

void destroyLinkedMultiPolygon(LinkedGeoPolygon *polygon);

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.

Free all allocated memory for a linked geo structure. The caller is responsible for freeing memory allocated to the input polygon struct.