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

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.4

Key enhancements in InfluxDB 3.4 and the InfluxDB 3 Explorer 1.2.

See the Blog Post

InfluxDB 3.4 is now available for both Core and Enterprise, which introduces offline token generation for use in automated deployments and configurable license type selection that lets you bypass the interactive license prompt. InfluxDB 3 Explorer 1.2 is also available, which includes InfluxDB cache management and other new features.

For more information, check out: