Class: GeometryProviderBase

api.GeometryProviderBase

classdesc Base class to extend if implementing a geometry provider class.

example

class MyGeometryProvider extends GeometryProviderBase {     ...}

Hierarchy#

GeometryProviderBase
↳ S2GeometryProvider

Implements#

IGeometryProvider

Constructors#

constructor#

• new GeometryProviderBase()

Create a new geometry provider base instance.

Defined in#

api/GeometryProviderBase.ts:26

Methods#

bboxToCellIds#

▸ bboxToCellIds(sw, ne): string[]

Convert a geodetic bounding box to the the minimum set of cell ids containing the bounding box.

description The bounding box needs to be sufficiently small to be contained in an area with the size of maximally four tiles. Up to nine adjacent tiles may be returned.

Parameters#

Name	Type	Description
`sw`	`LngLat`	South west corner of bounding box.
`ne`	`LngLat`	North east corner of bounding box.

Returns#

string[]

Array of cell ids.

Implementation of#

IGeometryProvider.bboxToCellIds

Defined in#

api/GeometryProviderBase.ts:41

getAdjacent#

▸ getAdjacent(cellId): string[]

Get the cell ids of all adjacent cells.

description In the case of approximately rectangular cells this is typically the eight orthogonally and diagonally adjacent cells.

Parameters#

Name	Type	Description
`cellId`	`string`	Id of cell.

Returns#

string[]

Array of cell ids. No specific order is guaranteed.

Implementation of#

IGeometryProvider.getAdjacent

Defined in#

api/GeometryProviderBase.ts:56

getVertices#

▸ getVertices(cellId): LngLat[]

Get the vertices of a cell.

description The vertices form an unclosed clockwise polygon in the 2D longitude, latitude space. No assumption on the position of the first vertex relative to the others can be made.