Kotlin BSON/opensavvy.ktmongo.bson.types/Geo/Polygon

Polygon

@Serializable(with = Geo.Polygon.Serializer::class)

data class Polygon(val rings: List<Geo.LineString>) : Geo(source)

A GeoJSON polygon.

A polygon is a shape that may have holes.

A simple polygon has a single ring (e.g., a triangle, a square). More complex polygons can have multiple rings that represent holes (e.g., a doughnut shape).

To learn more about the different kinds of polygons, see the constructors.

External resources

Constructors

Polygon

constructor(rings: List<Geo.LineString>)

constructor(vararg rings: Geo.LineString)

Constructs a Polygon instance from multiple LineString instances.

constructor(vararg points: Geo.Point)

Constructs a single-ring Geo.Polygon instance from multiple Point instances.

Types

Serializer

@LowLevelApi

object Serializer : KSerializer<Geo.Polygon>

Properties

rings

val rings: List<Geo.LineString>

The various rings of this polygon.

Functions

toString

open override fun toString(): String

JSON representation of this object as a BSON document.

writeTo

open override fun writeTo(writer: BsonFieldWriter)

Writes this object to the provided writer.