Documentation

geo.getGrid() function

geo.getGrid() is experimental and subject to change at any time.

geo.getGrid() calculates a grid or set of cell ID tokens for a specified region.

Note: S2 grid cells may not perfectly align with the defined region, so results include S2 grid cells fully and partially covered by the region.

Function type signature
(
    region: A,
    units: {distance: string},
    ?level: int,
    ?maxLevel: int,
    ?maxSize: int,
    ?minSize: int,
) => {set: [string], level: int} where A: Record
  • Copy
  • Fill window

For more information, see Function type signatures.

Parameters

region

(Required) Region used to return S2 cell ID tokens. Specify record properties for the region shape.

minSize

Minimum number of cells that cover the specified region.

maxSize

Minimum number of cells that cover the specified region.

level

S2 cell level of grid cells.

maxLevel

Maximumn S2 cell level of grid cells.

units

(Required) Record that defines the unit of measurement for distance.


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: