Package-level declarations

Kotlin DSL builders for ergonomic construction of GeoJSON objects with type-safe builder functions for geometries, features, and feature collections.

Types

Link copied to clipboard
class FeatureBuilder<G : Geometry?, P>(var geometry: G, var properties: P)

Builder for constructing Feature objects using a DSL.

Link copied to clipboard

Builder for constructing FeatureCollection objects using a DSL.

Link copied to clipboard

Builder for constructing GeometryCollection objects using a DSL.

Link copied to clipboard

Builder for constructing LineString objects using a DSL.

Link copied to clipboard

Builder for constructing MultiLineString objects using a DSL.

Link copied to clipboard

Builder for constructing MultiPoint objects using a DSL.

Link copied to clipboard

Builder for constructing MultiPolygon objects using a DSL.

Link copied to clipboard

Builder for constructing Polygon objects using a DSL.

Functions

Link copied to clipboard
inline fun <G : Geometry, P : @Serializable Any> FeatureCollectionBuilder<in G?, in P?>.addFeature(builderAction: FeatureBuilder<G?, P?>.() -> Unit = {})
inline fun <G : Geometry?, P : @Serializable Any> FeatureCollectionBuilder<in G, in P?>.addFeature(geometry: G, builderAction: FeatureBuilder<G, P?>.() -> Unit = {})

Adds a Feature to a FeatureCollectionBuilder with geometry provided upfront.

inline fun <G : Geometry?, P> FeatureCollectionBuilder<in G, in P>.addFeature(geometry: G, properties: P, builderAction: FeatureBuilder<G, P>.() -> Unit = {})

Adds a Feature to a FeatureCollectionBuilder with both geometry and properties provided upfront.

Link copied to clipboard

Adds a LineString to a GeometryCollectionBuilder using a DSL.

Adds a LineString to a MultiLineStringBuilder using a DSL.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun GeometryCollectionBuilder<in Point>.addPoint(coordinates: Position, bbox: BoundingBox? = null)
fun LineStringBuilder.addPoint(coordinates: Position, bbox: BoundingBox? = null)
fun MultiPointBuilder.addPoint(coordinates: Position, bbox: BoundingBox? = null)
Link copied to clipboard
inline fun GeometryCollectionBuilder<in Polygon>.addPolygon(builderAction: PolygonBuilder.() -> Unit)

Adds a Polygon to a GeometryCollectionBuilder using a DSL.

inline fun MultiPolygonBuilder.addPolygon(builderAction: PolygonBuilder.() -> Unit)

Adds a Polygon to a MultiPolygonBuilder using a DSL.

Link copied to clipboard
inline fun PolygonBuilder.addRing(builderAction: LineStringBuilder.() -> Unit)

Adds a ring to a PolygonBuilder using a DSL.

Link copied to clipboard
inline fun <G : Geometry, P : @Serializable Any> buildFeature(builderAction: FeatureBuilder<G?, P?>.() -> Unit = {}): Feature<G?, P?>

Builds a Feature using a DSL.

inline fun <G : Geometry?, P : @Serializable Any> buildFeature(geometry: G, builderAction: FeatureBuilder<G, P?>.() -> Unit = {}): Feature<G, P?>

Builds a Feature using a DSL with Geometry provided upfront.

inline fun <G : Geometry?, P> buildFeature(geometry: G, properties: P, builderAction: FeatureBuilder<G, P>.() -> Unit = {}): Feature<G, P>

Builds a Feature using a DSL with both geometry and properties provided upfront.

Link copied to clipboard
inline fun <G : Geometry?, P> buildFeatureCollection(builderAction: FeatureCollectionBuilder<G, P>.() -> Unit): FeatureCollection<G, P>

Builds a FeatureCollection using a DSL.

Link copied to clipboard

Builds a GeometryCollection using a DSL.

Link copied to clipboard
inline fun buildLineString(builderAction: LineStringBuilder.() -> Unit): LineString

Builds a LineString using a DSL.

Link copied to clipboard

Builds a MultiLineString using a DSL.

Link copied to clipboard
inline fun buildMultiPoint(builderAction: MultiPointBuilder.() -> Unit): MultiPoint

Builds a MultiPoint using a DSL.

Link copied to clipboard
inline fun buildMultiPolygon(builderAction: MultiPolygonBuilder.() -> Unit): MultiPolygon

Builds a MultiPolygon using a DSL.

Link copied to clipboard
inline fun buildPolygon(builderAction: PolygonBuilder.() -> Unit): Polygon

Builds a Polygon using a DSL.

Link copied to clipboard

Creates an empty FeatureCollection.

fun <T : Geometry?, P> featureCollectionOf(vararg features: Feature<T, P>): FeatureCollection<T, P>

Creates a FeatureCollection from multiple Feature objects.

Link copied to clipboard
fun <G : Geometry> geometryCollectionOf(vararg geometries: G): GeometryCollection<G>

Creates a GeometryCollection from multiple Geometry objects.

Link copied to clipboard
fun lineStringOf(vararg coordinates: Position): LineString

Creates a LineString from multiple Position objects.

Link copied to clipboard
fun multiLineStringOf(vararg coordinates: List<Position>): MultiLineString

Creates a MultiLineString from multiple lists of Position objects.

fun multiLineStringOf(vararg lineStrings: LineString): MultiLineString

Creates a MultiLineString from multiple LineString objects.

Link copied to clipboard
fun multiPointOf(vararg points: Point): MultiPoint

Creates a MultiPoint from multiple Point objects.

fun multiPointOf(vararg coordinates: Position): MultiPoint

Creates a MultiPoint from multiple Position objects.

Link copied to clipboard
fun multiPolygonOf(vararg coordinates: List<List<Position>>): MultiPolygon

Creates a MultiPolygon from multiple lists of lists of Position objects.

fun multiPolygonOf(vararg polygons: Polygon): MultiPolygon

Creates a MultiPolygon from multiple Polygon objects.

Link copied to clipboard
fun polygonOf(vararg coordinates: List<Position>): Polygon

Creates a Polygon from multiple lists of Position objects (rings).