maplibre-compose/org.maplibre.compose.offline

Package-level declarations

Functionality for managing offline map data and caching.

Functionality for managing offline map data and caching.

Functionality for managing offline map data and caching.

Types

DownloadProgress

sealed interface DownloadProgress

enum DownloadStatus : Enum<DownloadStatus>

Represents whether an OfflinePack is actively downloading or has completed downloading.

interface OfflineManager

An instance of this interface is a singleton that manages offline packs and ambient caching.

OfflineManagerException

class OfflineManagerException(message: String) : Exception

actual class OfflinePack : OfflineRegion.OfflineRegionObserver

actual class OfflinePack

expect class OfflinePack

Represents a collection of resources necessary for viewing a region offline.

OfflinePackDefinition

sealed interface OfflinePackDefinition

An object that defines a region required by an OfflinePack.

Functions

getOfflineManager

fun getOfflineManager(context: Context): OfflineManager

Acquire an instance of OfflineManager outside a Composition. For use in Composable code, see org.maplibre.compose.offline.rememberOfflineManager.

fun getOfflineManager(): OfflineManager

Acquire an instance of OfflineManager outside a Composition. For use in Composable code, see org.maplibre.compose.offline.rememberOfflineManager.

rememberOfflineManager

@Composable

actual fun rememberOfflineManager(): OfflineManager

@Composable

actual fun rememberOfflineManager(): OfflineManager

@Composable

expect fun rememberOfflineManager(): OfflineManager

Acquire an instance of OfflineManager.

rememberOfflinePacksSource

@Composable

fun rememberOfflinePacksSource(offlinePacks: Set<OfflinePack>, options: GeoJsonOptions = GeoJsonOptions(), putExtraProperties: JsonObjectBuilder.(OfflinePack) -> Unit = {}): Source

Specialization of rememberGeoJsonSource that contains the list of OfflinePack as features. This allows you to implement a UI to manage offline packs directly on the map.