MapLibre Native Android/org.maplibre.android/MapLibre/getInstance

getInstance

@UiThread

@NonNull

open fun getInstance(@NonNull context: Context): MapLibre(source)

Get an instance of MapLibre.

This class manages the API key, application context, and connectivity state.

Return

the single instance of MapLibre

Parameters

context

Android context which holds or is an application context

@UiThread

@NonNull

open fun getInstance(@NonNull context: Context, @Nullable apiKey: String, @NonNull tileServer: WellKnownTileServer): MapLibre(source)

Get an instance of MapLibre.

This class manages the API key, application context, and connectivity state.

Return

the single instance of MapLibre

Parameters

context

Android context which holds or is an application context

apiKey

api key

tileServer

the tile server whose predefined configuration will be used to bootstrap the SDK. The predefined configuration includes rules for converting resource URLs between normal and canonical forms and set of predefined styles available on the server.

@UiThread

@NonNull

open fun getInstance(@NonNull context: Context, @Nullable apiKey: String, @NonNull tileServer: WellKnownTileServer, @Nullable type: RenderingEngine.Type): MapLibre(source)

Get an instance of MapLibre, explicitly picking the rendering engine to use.

This class manages the API key, application context, and connectivity state.

Return

the single instance of MapLibre

Parameters

context

Android context which holds or is an application context

apiKey

api key

tileServer

type

the rendering engine to use; ignored if MapLibre has already been initialized in this process. If null, the default rendering engine will be used.

Throws

java.lang.UnsupportedOperationException

if type isn't supported by this build of the SDK (single-backend flavors only support their compiled-in backend).