## version-6.0

### Additional Guides

# Additional Guides

> 

Additional guides for Mappedin SDK for Android v6 are coming soon.

### API Reference

# API Reference
## Latest Version


Mappedin SDK for Android v6.0.0-alpha.1





## Previous Versions

### Getting Started

# Getting Started

> 

Mappedin SDK for Android helps to deliver the rich indoor mapping experience of a venue, inside Android apps.

The Mappedin SDK for Android is a native interface to Mappedin JS. The SDK is a dependency built using Kotlin, and it automatically handles any authentication, network communication, fetching of map data, its display, and basic user interaction, such as panning, tapping, and zooming. The SDK allows a developer to build their own interactions. Additional layers can be rendered on top of the map.

:::info
Mappedin SDK for Android is supported on Android versions 8.0 and above.
:::

## Coding with AI

Mappedin SDK for Android provides an llms-mappedin-android.txt file that can be used to help with coding when using Large Language Models (LLMs).



## Android Studio Project Setup

### Add Permissions

Add the following permissions to the `AndroidManifest.xml` in the `application` tag.


```xml
<uses-permission android:name="android.permission.INTERNET" />
<!--Permissions below are only needed if displaying user location-->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT"/>
```


Ensure that hardware acceleration is not turned off by setting it to `true`.


```xml
<application
    android:hardwareAccelerated="true"
/>
```

Ensure that the application has a large heap by setting it to `true`.


```xml
<application
    android:largeHeap="true"
/>
```


### Add Application Dependency to Gradle

Add the Mappedin SDK dependency to the application's `build.gradle`, `settings.gradle` or `libs.versions.toml` and sync the changes to download the SDK. The latest version can be found in in Maven Central.

#### build.gradle or settings.gradle

```
implementation 'com.mappedin.sdk:mappedin:6.0.0-alpha.1'
```


#### libs.versions.toml


```
[versions]
mappedin = "6.0.0-alpha.1"

[libraries]
mappedin = { module = "com.mappedin.sdk:mappedin", version.ref = "mappedin" }
```


:::tip
The Mappedin Android Github repository contains  a reference project that demonstrates how to use the Mappedin SDK for Android.
:::

### Display a Map

The core class of the Mappedin SDK for Android is MapView, which is responsible for instantiating an Android WebView that loads Mappedin JS. MapView is the core class of which all other views and data models can be accessed.

#### Load Map Data

Call MapView.getMapData to load map data from Mappedin servers. This function must be called first and map data must be loaded before any other Mappedin functions can be called.


```kotlin
// See Trial API key Terms and Conditions
// https://developer.mappedin.com/docs/demo-keys-and-maps
val options =
    GetMapDataWithCredentialsOptions(
        key = "mik_yeBk0Vf0nNJtpesfu560e07e5",
        secret = "mis_2g9ST8ZcSFb5R9fPnsvYhrX3RyRwPtDGbMGweCYKEq385431022",
        mapId = "64ef49e662fd90fe020bee61",
    )

// Load the map data.
mapView.getMapData(options) { result ->
    result.onSuccess {
        Log.d("MappedinDemo", "getMapData success")
    }
}
```


#### Show a Map

Call MapView.show3dMap to display the map.


```kotlin
mapView.show3dMap(Show3DMapOptions()) { result ->
    result.onSuccess {
        Log.d("MappedinDemo", "show3dMap success")
    }
}
```


The following sample code combines the loading of map data and the display of the map and includes a function to be called when the map is ready.


```kotlin
// See Trial API key Terms and Conditions
// https://developer.mappedin.com/docs/demo-keys-and-maps
val options =
    GetMapDataWithCredentialsOptions(
        key = "mik_yeBk0Vf0nNJtpesfu560e07e5",
        secret = "mis_2g9ST8ZcSFb5R9fPnsvYhrX3RyRwPtDGbMGweCYKEq385431022",
        mapId = "64ef49e662fd90fe020bee61",
    )

// Load the map data.
mapView.getMapData(options) { result ->
    result
        .onSuccess {
            Log.d("MappedinDemo", "getMapData success")
        // Display the map.
        mapView.show3dMap(Show3DMapOptions()) { r ->
            r.onSuccess {
                runOnUiThread {
                    loadingIndicator.visibility = android.view.View.GONE
                }
                onMapReady(mapView)
            }
            r.onFailure {
                runOnUiThread {
                    loadingIndicator.visibility = android.view.View.GONE
                }
                Log.e("MappedinDemo", "show3dMap error: $it")
            }
        }
        }.onFailure {
            Log.e("MappedinDemo", "getMapData error: $it")
        }
}

// Place your code to be called when the map is ready here.
private fun onMapReady(mapView: MapView) {
  Log.d("MappedinDemo", "show3dMap success - Map displayed")
}
```



#### Result

The app should display something that looks like this in the Android Emulator:



And zooming in to have a closer look:




## Debug Mode

Use Debug Mode to get a closer look at how various map components behave and interact. Here's how to enable it:

### 1. Enable Debug Mode

To activate the debug interface, call the following function in your code:


```kotlin
mapView.enableDebug()
```


MapView.enableDebug displays a panel on the right side of the map, revealing several tools and controls for direct interaction with the map's elements.

### 2. Navigating the Debug Panel

The debug panel provides access to a variety of controls:

**Geometry Controls**

-   Adjust individual geometry settings, such as color, opacity, visibility. These controls make it easy to see how different elements respond to changes.

**Interactivity**

-   Use toggles to turn interactivity on/off
-   Change colors and hover effects to highlight specific areas

**Scene Controls**

-   Manage the overall scene settings, such as scaling, positioning, and group management. Toggle the visibility of groups or containers within the scene
-   Adjust padding, scale, and watermark positioning
-   Markers & Labels — Add, remove, or edit markers and labels directly through the panel

**Camera Controls**

-   Fine-tune camera settings, including zoom levels, pitch, and center position
-   Set minimum and maximum zoom levels
-   Adjust the focus to a specific area or level

!enable debug

### Release Notes

# Release Notes

Mappedin SDK for Android release notes are posted here and this page will be kept up-to-date as updates are released. The SDK is available by adding the Mappedin SDK for Android to your project.


**build.gradle** or **settings.gradle**

```
implementation 'com.mappedin.sdk:mappedin:6.0.0-alpha.1'
```


**libs.versions.toml**


```
[versions]
mappedin = "6.0.0-alpha.1"

[libraries]
mappedin = { module = "com.mappedin.sdk:mappedin", version.ref = "mappedin" }
```



{

// Release notes template:

// https://keepachangelog.com/en/1.0.0/#how

// ## vXX.XX.XX - Month Day, Year
// _ Added
// _ Changed
// _ Deprecated
// _ Removed
// _ Fixed
// _ Security

}

## v6.0.0-alpha.1 - December 4, 2025

- Upgraded to Mappedin JS v6.7.0.

## v6.0.0-alpha.0 - December 3, 2025

- Initial release of Mappedin SDK for Android v6.