Basic Usage / Quick Start
August 31, 2022 ยท View on GitHub
Here's some (really) quick and dirty examples to get you started with using the library, broken down in (more or less) the same format as the upstream API documentation. Note that these examples assume you've imported H3.Algorithms and H3.Extensions, i.e.:
using H3;
using H3.Algorithms;
using H3.Extensions;
Upstream C function names are also provided for reference.
- Indexing functions - from/to
stringandulong; creating an index from a geospatial coordinate; getting the centroid of an index - Index inspection functions - get an indexes resolution, base cell, validity, whether it's a pentagon
- Grid traversal functions - k-rings + lines, local IJ coordinates
- Hierarchical grid functions - parent/child/children indices
- Region functions - polyfill
Note that this does not represent the entirety of the library's API; many functions and low-level operations that are internal to the upstream library are (presently) exposed as public APIs, allowing you to pretty much manipulate an index as you see fit.
The H3.Test project contains examples of using various parts of the library's API, and there's decent-ish documentation within the actual source.
Other Examples
If you have any examples you'd like to share here, feel free to submit a PR!