mapsglmaps/com.xweather.mapsgl.layers.spec/CircleLayerDescriptor

CircleLayerDescriptor

data class CircleLayerDescriptor(var id: String, var source: String, var sourceLayer: String? = null, var paint: CircleLayerPaint = CircleLayerPaint( fill = FillPaint(), stroke = StrokePaint(), circle = CirclePaint() ), var filter: Expression? = null) : VectorLayerDescriptor<CircleLayerPaint> , LayerEventEmitter

Descriptor for a Mapbox circle layer: points rendered as filled disks with optional stroke, driven by a vector or GeoJSON source.

Register the backing source first (com.xweather.mapsgl.map.MapController.addSource), then add this layer with com.xweather.mapsgl.map.MapController.addLayer. The layer is implemented as a VectorTileLayer over Mapbox’s native circle layer.

Sources

Vector tile source (com.xweather.mapsgl.sources.source.spec.VectorSourceDescriptor): set sourceLayer to the MVT layer name. filter may narrow features.
GeoJSON source (com.xweather.mapsgl.sources.source.spec.GeoJSONSourceDescriptor): set sourceLayer to null; the whole com.mapbox.geojson.FeatureCollection is used (see product examples such as earthquakes).

Paint is held in paint (CircleLayerPaint): fill color, stroke, and circle radius map to Mapbox circle-color, circle-radius, circle-stroke-*, etc. Use com.xweather.mapsgl.style.StyleValue and Expression for data-driven styling (e.g. magnitude-based radius).

Stacking: the beforeID argument to com.xweather.mapsgl.map.MapController.addLayer controls insertion order relative to existing style layers (see that method’s KDoc).

Constructors

CircleLayerDescriptor

constructor(id: String, source: String, sourceLayer: String? = null, paint: CircleLayerPaint = CircleLayerPaint( fill = FillPaint(), stroke = StrokePaint(), circle = CirclePaint() ), filter: Expression? = null)