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!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.