Placekey Functions

A range of functions are available to process Placekeys in Studio expressions.

Function Arguments Return Type Description
geoToPlacekey() real, real string Returns only the Where Part of a Placekey corresponding to the latitude and longitude arguments.
placekeyToLat() string real Returns the latitude of the centroid of the H3 hexagon in the Where Part of a Placekey.
placekeyToLng() string real Returns the longitude of the centroid of the H3 hexagon in the Where Part of a Placekey.
placekeyIsValid() string boolean Returns true if the Placekey is valid.
placekeyDistance() string, string integer Returns the distance between the centroids of the H3 hexagons in the Where Parts of two Placekeys.
placekeyToH3() string string Returns the Where Part of a Placekey (in H3 hexagon ID encoding).
h3ToPlacekey() string string Returns a Placekey containing the Where Part corresponding to the given H3 aperture 10 hexagon.