Class Quadkey

constructor

• new Quadkey(key?: bigint): Quadkey

  Parameters

  • key: bigint = 0n

  Returns Quadkey

key

type

Static Readonlyroot

Static Readonlytype

Static ReadonlyZero

base10String

• get base10String(): string

  Returns string

base16String

• get base16String(): string

  Returns string

base4Hash

• get base4Hash(): string

  Returns string

base4HashLabel

• get base4HashLabel(): string

  Returns string

boundingBox

• get boundingBox(): MercatorBoundingBox

  Returns MercatorBoundingBox

center

• get center(): LngLat

  Returns LngLat

children

• get children(): Quadkey[]

  Returns Quadkey[]

gridLocation

• get gridLocation(): { col: number; row: number; zoom: number }

  Returns { col: number; row: number; zoom: number }

id

• get id(): bigint

  Returns bigint

parent

• get parent(): undefined | Quadkey

  Returns undefined | Quadkey

siblings

• get siblings(): Quadkey[]

  Returns Quadkey[]

tile

• get tile(): MercatorTile

  Returns MercatorTile

valid

• get valid(): boolean

  Returns boolean

zoom

• get zoom(): number

  Returns number

childrenByZoom

• childrenByZoom(zoom: number): Quadkey[]

  Parameters

  • zoom: number

  Returns Quadkey[]

clone

• clone(): Quadkey

  Returns Quadkey

equals

• equals(obj: Quadkey): boolean

  Parameters

  • obj: Quadkey

  Returns boolean

geoJson

• geoJson(): GeoJson

  Returns GeoJson

getGridBoundingBox

• getGridBoundingBox(
      size: number,
  ): { height: number; left: number; top: number; width: number }

  Parameters

  • size: number

  Returns { height: number; left: number; top: number; width: number }

getGridLocation

• getGridLocation(): { col: number; row: number; zoom: number }

  Returns { col: number; row: number; zoom: number }

  Deprecated

  use .gridLocation instead

isInBoundingBox

• isInBoundingBox(boundingBox: MercatorBoundingBox): boolean

  Parameters

  • boundingBox: MercatorBoundingBox

  Returns boolean

relative

• relative(direction: string): Quadkey

  Parameters

  • direction: string

  Returns Quadkey

setId

• setId(id: bigint): Quadkey

  Parameters

  • id: bigint

  Returns Quadkey

setKey

• setKey(zoom: number, key: bigint): Quadkey

  Parameters

  • zoom: number
  • key: bigint

  Returns Quadkey

setZoom

• setZoom(zoom: number): Quadkey

  Parameters

  • zoom: number

  Returns Quadkey

toJSON

• toJSON(): string

  Returns string

toString

• toString(): string

  Returns string

Staticfrom

• from(zoom: number, id: bigint): Quadkey

  Parameters

  • zoom: number
  • id: bigint

  Returns Quadkey

StaticfromArrayBuffer

• fromArrayBuffer(zoom: number, id: ArrayBuffer): Quadkey

  Parameters

  • zoom: number
  • id: ArrayBuffer

  Returns Quadkey

StaticfromBase16String

• fromBase16String(value: string): Quadkey

  Parameters

  • value: string

  Returns Quadkey

StaticfromBase4String

• fromBase4String(value?: string): Quadkey

  Parameters

  • Optionalvalue: string

  Returns Quadkey

StaticfromBoundingBox

• fromBoundingBox(boundingBox: MercatorBoundingBox, zoom: number): Quadkey[]

  Parameters

  • boundingBox: MercatorBoundingBox
  • zoom: number

  Returns Quadkey[]

StaticfromLngLat

• fromLngLat(point: LngLatLike, zoom: number): Quadkey

  Parameters

  • point: LngLatLike
  • zoom: number

  Returns Quadkey

StaticfromString

• fromString(zoom: number, id: string, base?: number): Quadkey

  Parameters

  • zoom: number
  • id: string
  • base: number = 16

  Returns Quadkey

StaticfromTile

• fromTile(tile: MercatorTile): Quadkey

  Parameters

  • tile: MercatorTile

  Returns Quadkey