geojson/org.maplibre.spatialk.geojson/FeatureCollection

FeatureCollection

@Serializable(with = FeatureCollectionSerializer::class)

data class FeatureCollection<out G : Geometry?, out P> @JvmOverloads constructor(val features: List<Feature<G, P>> = emptyList(), val bbox: BoundingBox? = null, val foreignMembers: JsonObject = EmptyForeignMembers) : Collection<Feature<G, P>> , GeoJsonObject(source)

A FeatureCollection object is a collection of Feature objects. This class implements the Collection interface and can be used as a collection directly. The list of Feature objects contained in this FeatureCollection is also accessible through the features property.

See RFC 7946 Section 3.3 for the full specification.

Constructors

FeatureCollection

constructor(features: List<Feature<G, P>> = emptyList(), bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

constructor(vararg features: Feature<G, P>, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

Constructs a FeatureCollection from a vararg of Feature objects.

Types

object Companion

Factory methods for creating and serializing FeatureCollection objects.

Properties

open override val bbox: BoundingBox?

An optional BoundingBox used to represent the limits of the object's Geometry.

val features: List<Feature<G, P>>

The collection of Feature objects stored in this FeatureCollection

open override val foreignMembers: JsonObject

Members not defined by RFC 7946.

open override val size: Int

Functions

open operator override fun contains(element: Feature<G, P>): Boolean

open override fun containsAll(elements: Collection<Feature<G, P>>): Boolean

decodeForeignMembers

@HiddenFromObjC

inline fun <T : Any> GeoJsonObject.decodeForeignMembers(json: Json = GeoJson.jsonFormat): T

Decodes GeoJsonObject.foreignMembers as T.

operator fun get(index: Int): Feature<G, P>

Get the feature at the specified index.

getForeignMember

fun GeoJsonObject.getForeignMember(key: String): JsonElement?

Returns the foreign member with the given key, or null if it is not present.

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<Feature<G, P>>