docs-v2

2.0 KiB

Raw Permalink Blame History

title

description

weight

geo.getGrid() function

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

flux_v0_ref

name	parent	identifier
geo.getGrid	experimental/geo	experimental/geo/getGrid

201

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

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

region

({{< req >}}) 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

({{< req >}}) Record that defines the unit of measurement for distance.

2.0 KiB Raw Permalink Blame History