geo.s2CellIDToken() function

geo.s2CellIDToken() returns and S2 cell ID token for given cell or point at a specified S2 cell level.

Function type signature

(level: int, ?point: {lon: float, lat: float}, ?token: string) => string

Parameters

token

S2 cell ID token to update.

Useful for changing the S2 cell level of an existing S2 cell ID token.

point

Record with lat and lon properties that specify the latitude and longitude in decimal degrees (WGS 84) of a point.

level

(Required) S2 cell level to use when generating the S2 cell ID token.

Examples

• Use latitude and longitude values to generate S2 cell ID tokens
• Update S2 cell ID token level

Use latitude and longitude values to generate S2 cell ID tokens

import "experimental/geo"

data
    |> map(
        fn: (r) =>
            ({r with s2_cell_id: geo.s2CellIDToken(point: {lat: r.lat, lon: r.lon}, level: 10)}),
    )

Update S2 cell ID token level

import "experimental/geo"

data
    |> map(fn: (r) => ({r with s2_cell_id: geo.s2CellIDToken(token: r.s2_cell_id, level: 5)}))