geojson/org.maplibre.spatialk.geojson/Position

Position

@Serializable(with = PositionSerializer::class)

class Position : Iterable<Double> (source)

A Position is the fundamental geometry construct.

In JSON, a position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, or easting and northing, precisely in that order using decimal numbers. Altitude or elevation MAY be included as an optional third element.

When serialized, the latitude, longitude, and altitude (if present) will be represented as an array.

Position(longitude = -75.0, latitude = 45.0)

Will be serialized as

[-75.0,45.0]

See RFC 7946 Section 3.1.1 for the full specification.

Constructors

Position

constructor(longitude: Double, latitude: Double)

Construct a Position with longitude and latitude.

constructor(longitude: Double, latitude: Double, altitude: Double)

Construct a Position with longitude, latitude, and altitude.

constructor(longitude: Double, latitude: Double, altitude: Double? = null)

Construct a Position with longitude, latitude, and optional altitude.

constructor(longitude: Double, latitude: Double, altitude: Double, vararg additionalElements: Double)

Construct a Position with more than the standard three axes (longitude, latitude, altitude).

Types

Companion

object Companion

Factory methods for creating and serializing Position objects.

Properties

altitude

val altitude: Double?

Optionally, an altitude or elevation for this position in meters above or below the WGS84 reference ellipsoid.

hasAltitude

@get:JvmName(name = "hasAltitude")

val hasAltitude: Boolean

Whether this position has an altitude component.

latitude

val latitude: Double

The latitude value of this position (or northing value for projected coordinates) in degrees.

longitude

val longitude: Double

The longitude value of this position (or easting value for projected coordinates) in degrees.

size

val size: Int

The number of elements in the coordinates array.

Functions

component1

operator fun component1(): Double

Destructuring component for longitude.

component2

operator fun component2(): Double

Destructuring component for latitude.

component3

operator fun component3(): Double?

Destructuring component for altitude.

equals

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

get

operator fun get(index: Int): Double

Get the coordinate at the given index.

getOrNull

fun getOrNull(index: Int): Double?

hashCode

open override fun hashCode(): Int

iterator

open operator override fun iterator(): Iterator<Double>

toJson

fun toJson(): String

Serialize this position to a JSON string.

toString

open override fun toString(): String

Position

See also

Constructors

Types

Properties

Functions