maplibre-compose-expressions/dev.sargunv.maplibrecompose.expressions.dsl/Feature

Feature

Object to access feature-related data, see feature

Functions

Gets the value of a cluster property accumulated so far. Can only be used in the clusterProperties option of a clustered GeoJSON source, see dev.sargunv.maplibrecompose.core.source.GeoJsonOptions.

distance

fun distance(geometry: Expression<GeoJsonValue>): Expression<FloatValue>

Returns the shortest distance in meters between the evaluated feature and geometry.

geometryType

fun geometryType(): Expression<GeometryType>

Gets the feature's geometry type.

get

operator fun get(key: Expression<StringValue>): Expression<*>

operator fun get(key: String): Expression<*>

Returns the value corresponding to the given key in the current feature's properties or null if it is not present.

has

fun has(key: Expression<StringValue>): Expression<BooleanValue>

fun has(key: String): Expression<BooleanValue>

Tests for the presence of a property value key in the current feature's properties.

fun <T : ExpressionValue> id(): Expression<T>

Gets the feature's id, if it has one.

lineProgress

fun lineProgress(value: Expression<FloatValue>): Expression<FloatValue>

fun lineProgress(value: Float): Expression<FloatValue>

Gets the progress along a gradient line. Can only be used in the gradient property of a line layer, see dev.sargunv.maplibrecompose.compose.layer.LineLayer.

properties

fun properties(): Expression<MapValue<*>>

Gets the feature properties object. Note that in some cases, it may be more efficient to use get("property_name") directly.

state

fun <T : ExpressionValue> state(key: Expression<StringValue>): Expression<T>

fun <T : ExpressionValue> state(key: String): Expression<T>

Note: Not supported on native platforms. See maplibre-native#1698

within

fun within(geometry: Expression<GeoJsonValue>): Expression<BooleanValue>

Returns true if the evaluated feature is fully contained inside a boundary of the input geometry, false otherwise. The input value can be a valid GeoJSON of type Polygon, MultiPolygon, Feature, or FeatureCollection. Supported features for evaluation: