geojson/org.maplibre.spatialk.geojson/Feature

Feature

@Serializable(with = FeatureSerializer::class)

data class Feature<out G : Geometry?, out P> @JvmOverloads constructor(val geometry: G, val properties: P, val id: FeatureId? = null, val bbox: BoundingBox? = null, val foreignMembers: JsonObject = EmptyForeignMembers) : GeoJsonObject(source)

A Feature object represents a spatially bounded thing.

See RFC 7946 Section 3.2 for the full specification.

Type Parameters

G

The type of Geometry contained in this Feature.

P

The type of properties. This can be any type that serializes to a JSON object. For dynamic or unknown property schemas, use JsonObject. For known schemas, use a Serializable data class.

See also

FeatureCollection

Constructors

constructor(geometry: G, properties: P, id: FeatureId? = null, bbox: BoundingBox? = null, foreignMembers: JsonObject = EmptyForeignMembers)

Types

object Companion

Factory methods for creating and serializing Feature objects.

Properties

open override val bbox: BoundingBox?

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

open override val foreignMembers: JsonObject

Additional members as defined in RFC 7946 §6.1.

val geometry: G

A Geometry object contained within the Feature.

val id: FeatureId?

An optionally included string or number that commonly identifies this Feature.

val properties: P

Additional properties about this Feature. It should be serializable into a JsonObject.

Functions

containsProperty

fun Feature<*, JsonObject?>.containsProperty(key: String): Boolean

Checks if a property exists in the feature's JsonObject properties.

decodeForeignMembers

@HiddenFromObjC

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

Decodes GeoJsonObject.foreignMembers as T.

getBooleanProperty

fun Feature<*, JsonObject?>.getBooleanProperty(key: String): Boolean?

Gets a boolean property from the feature's JsonObject properties.

getDoubleProperty

fun Feature<*, JsonObject?>.getDoubleProperty(key: String): Double?

Gets a double property from the feature's JsonObject properties.

getForeignMember

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

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

fun Feature<*, JsonObject?>.getIntProperty(key: String): Int?

Gets an integer property from the feature's JsonObject properties.

getStringProperty

fun Feature<*, JsonObject?>.getStringProperty(key: String): String?

Gets a string property from the feature's JsonObject properties.