MapLibre Native Android/org.maplibre.android/MapLibre

MapLibre

@UiThread
class MapLibre

The entry point to initialize the MapLibre Android SDK.

Obtain a reference by calling getInstance. Usually this class is configured in Application#onCreate() and is responsible for the active API key, application context, and connectivity state.

Properties

Link copied to clipboard
@Nullable
@get:Nullable
open var apiKey: String
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun getApplicationContext(): Context
Application context
Link copied to clipboard
@UiThread
@NonNull
open fun getInstance(@NonNull context: Context): MapLibre
@UiThread
@NonNull
open fun getInstance(@NonNull context: Context, @Nullable apiKey: String, tileServer: WellKnownTileServer): MapLibre
Get an instance of MapLibre.
Link copied to clipboard
@Nullable
open fun getPredefinedStyle(name: String): DefaultStyle
Get predefined style by name
Link copied to clipboard
@Nullable
open fun getPredefinedStyles(): Array<DefaultStyle>
Get all pre-defined styles
Link copied to clipboard
open fun hasInstance(): Boolean
Internal use.
Link copied to clipboard
open fun isConnected(): Boolean
Determines whether we have an internet connection available.
Link copied to clipboard
open fun setConnected(connected: Boolean)
Manually sets the connectivity state of the app.
Link copied to clipboard
open fun throwIfApiKeyInvalid(@Nullable apiKey: String)
Throws exception when access token is invalid