SupportLog In

Placekey Functions

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

FunctionArgumentsReturn TypeDescription
geoToPlacekey()real, realstringReturns only the Where Part of a Placekey corresponding to the latitude and longitude arguments (respectively).
placekeyToLat()stringrealReturns the latitude of the the centroid of the H3 hexagon in the Where Part of a Placekey.
placekeyToLng()stringrealReturns the latitude of the the centroid of the H3 hexagon in the Where Part of a Placekey.
placekeyIsValid()stringbooleanReturns true if the Placekey is valid.
placekeyDistance()string, stringintegerReturns the distance between the centroids of the H3 hexagons in the Where Parts of two Placekeys.
placekeyToH3()stringstringReturns the Where Part of a Placekey (in H3 hexagon ID encoding).
h3ToPlacekey()stringstringReturns a Placekey containing the Where Part corresponding to the given H3 aperture 10 hexagon.