maplibre-compose/org.maplibre.compose.sources

Package-level declarations

Composables and related utilities to add sources to the map.

Types

ComputedSource

actual class ComputedSource : Source

expect class ComputedSource : Source

A map data source of tiled vector data generated with some custom logic

actual class ComputedSource : Source

ComputedSourceOptions

@Immutable

data class ComputedSourceOptions(val minZoom: Int = SourceDefaults.MIN_ZOOM, val maxZoom: Int = SourceDefaults.MAX_ZOOM, val buffer: Int = 128, val tolerance: Float = 0.375f, val clip: Boolean = false, val wrap: Boolean = false)

GeoJsonData

sealed interface GeoJsonData

GeoJsonOptions

@Immutable

data class GeoJsonOptions(val minZoom: Int = SourceDefaults.MIN_ZOOM, val maxZoom: Int = SourceDefaults.MAX_ZOOM, val buffer: Int = 128, val tolerance: Float = 0.375f, val cluster: Boolean = false, val clusterRadius: Int = 50, val clusterMinPoints: Int = 2, val clusterMaxZoom: Int = maxZoom - 1, val clusterProperties: Map<String, GeoJsonOptions.ClusterPropertyAggregator<*>> = emptyMap(), val lineMetrics: Boolean = false)

GeoJsonSource

actual class GeoJsonSource : Source

expect class GeoJsonSource : Source

A map data source consisting of geojson data.

actual class GeoJsonSource : Source

ImageSource

actual class ImageSource : Source

expect class ImageSource : Source

A map data source of an image placed at a given position.

actual class ImageSource : Source

RasterSource

actual class RasterSource : Source

expect class RasterSource : Source

A map data source of tiled map pictures.

actual class RasterSource : Source

Source

actual sealed class Source

expect sealed class Source

A data source for map data

actual sealed class Source

SourceDefaults

object SourceDefaults

TileCoordinateSystem

enum TileCoordinateSystem : Enum<TileCoordinateSystem>

TileSetOptions

@Immutable

data class TileSetOptions(val minZoom: Int = SourceDefaults.MIN_ZOOM, val maxZoom: Int = SourceDefaults.MAX_ZOOM, val tileCoordinateSystem: TileCoordinateSystem = TileCoordinateSystem.XYZ, val boundingBox: BoundingBox? = null, val attributionHtml: String? = null)

UnknownSource

actual class UnknownSource : Source

expect class UnknownSource : Source

actual class UnknownSource : Source

VectorSource

actual class VectorSource : Source

expect class VectorSource : Source

A map data source of tiled vector data.

actual class VectorSource : Source

Functions

getBaseSource

@Composable

fun getBaseSource(id: String): Source?

Get the source with the given id from the base style specified via the baseStyle parameter in MaplibreMap.

rememberGeoJsonSource

@Composable

fun rememberGeoJsonSource(options: ComputedSourceOptions = ComputedSourceOptions(), getFeatures: (bounds: BoundingBox, zoomLevel: Int) -> FeatureCollection): ComputedSource

Remember a new ComputedSource with the given options from the given getFeatures function.

@Composable

fun rememberGeoJsonSource(data: GeoJsonData, options: GeoJsonOptions = GeoJsonOptions()): GeoJsonSource

Remember a new GeoJsonSource with the given options from the given GeoJsonData.

rememberImageSource

@Composable

fun rememberImageSource(position: PositionQuad, bitmap: ImageBitmap): ImageSource

Remember a new ImageSource from the given bitmap.

@Composable

fun rememberImageSource(position: PositionQuad, uri: String): ImageSource

Remember a new ImageSource from the given uri.

rememberRasterSource

@Composable

fun rememberRasterSource(uri: String, tileSize: Int = SourceDefaults.RASTER_TILE_SIZE): RasterSource

Remember a new RasterSource with the given tileSize from the given uri.

@Composable

fun rememberRasterSource(tiles: List<String>, options: TileSetOptions = TileSetOptions(), tileSize: Int = SourceDefaults.RASTER_TILE_SIZE): RasterSource

rememberVectorSource

@Composable

fun rememberVectorSource(uri: String): VectorSource

Remember a new VectorSource from the given uri.

@Composable

fun rememberVectorSource(tiles: List<String>, options: TileSetOptions = TileSetOptions()): VectorSource