geohash/org.maplibre.spatialk.geohash/Geohash

Geohash

@Serializable(with = GeohashSerializer::class)

class Geohash : Comparable<Geohash> (source)

A rectangular cell on the WGS84 longitude and latitude plane, addressed by a Geohash string.

A Geohash is a cell rather than a string codec. Altitude is ignored.

Types

Companion

object Companion

Factories for valid Geohash cells.

Properties

boundingBox

val boundingBox: BoundingBox

The cell's two-dimensional extent in west, south, east, north order.

center

val center: Position

The geometric center of this cell.

children

val children: List<Geohash>

The 32 finer cells, in base32ghs character order.

length

val length: Int

Number of base32ghs characters in this cell's address.

neighbors

val neighbors: GeohashNeighbors

The adjacent cells at this length, with named compass directions.

parent

val parent: Geohash?

The enclosing cell one character shorter, or null when length is 1.

text

val text: String

This cell's lowercase base32ghs address.

Functions

compareTo

open operator override fun compareTo(other: Geohash): Int

Orders cells in the same order as their text forms.

contains

operator fun contains(other: Geohash): Boolean

Returns true when other is this cell or one of its descendants.

operator fun contains(position: Position): Boolean

Returns true when position falls inside this cell.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

offsetBy

fun offsetBy(east: Int, north: Int): Geohash?

Returns the cell reached by moving east cells east and north cells north.

toString

open override fun toString(): String

Returns text.

truncatedTo

fun truncatedTo(length: Int): Geohash

Returns the enclosing cell whose address has length characters.