## 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.1.0-alpha.1 ## Previous Versions v6.0.0-alpha.1 ### Building & Floor Selection # Building & Floor Selection > ## Floor Selection When mapping a building with multiple floors, each floor has its own unique map. These are represented by the Floor class, which are accessed using MapData.getByType(). The currently displayed Floor can be accessed using MapView.currentFloor. :::tip A complete example demonstrating Building and Floor Selection can be found in the Mappedin Android Github repo: BuildingFloorSelectionDemoActivity.kt ::: ### Changing Floors When initialized, MapView displays the Floor with the elevation that's closest to 0. This can be overridden by setting Show3DMapOptions.initialFloor to a Floor.id and passing it to MapView.show3dMap(). ```kotlin // Setting the initial floor to Floor.id 'm_123456789'. mapView.show3dMap(Show3DMapOptions(initialFloor = "m_123456789")) { r -> r.onSuccess { // Successfully initialized the map view. } r.onFailure { // Failed to initialize the map view. } } ``` The Floor displayed in a MapView can also be changed during runtime by calling MapView.setFloor() and passing in a Floor.id. ```kotlin // Set the floor to Floor.id 'm_987654321'. mapView.setFloor("m_987654321") { result -> result.onSuccess { Log.d("MappedinDemo", "Floor changed successfully") } } ``` ### Listening for Floor Changes Mappedin SDK for Android provides the ability to listen for floor changes on a MapView. The code below listens for the `floor-change` event and logs the new floor and building name to the console. ```kotlin mapView.on(Events.FLOOR_CHANGE) { data -> val payload = data as? FloorChangePayload payload?.let { Log.d( "MappedinDemo", "Floor changed to: ${it.floor.name} in building: ${it.floor.floorStack?.name}", ) } } ``` ## Building Selection Mappedin Maps can contain one to many buildings with each building having one to many floors. Each building has its floors organized into a FloorStack object. When multiple buildings are present, there are multiple FloorStack objects, one for each building. A FloorStack contains one to many Floor objects, each representing the map of each level of the building. The FloorStack object is accessed by using MapData.getByType(). ```kotlin // Get all floor stacks mapView.mapData.getByType(MapDataType.FLOOR_STACK) { result -> result.onSuccess { stacks -> floorStacks = stacks?.sortedBy { it.name } ?: emptyList() // Get all floors mapView.mapData.getByType(MapDataType.FLOOR) { floorsResult -> floorsResult.onSuccess { floors -> allFloors = floors ?: emptyList() Log.d("MappedinDemo", "Floors: $floors") } } } } ``` :::tip A complete example demonstrating Building and Floor Selection can be found in the Mappedin Android Github repo: BuildingFloorSelectionDemoActivity.kt ::: ### Enterprise Data # Enterprise Data > :::note > The Enterprise Data classes described in this guide are populated in Mappedin CMS, which requires a Solutions Tier subscription. ::: ## Enterprise Locations An EnterpriseLocation contains metadata about a location, such as its name, description, logo, phone number, social medial links, hours of operation and more. They can be accessed using the MapData.getByType() method as shown below. ```kotlin mapView.mapData.getByType(MapDataType.ENTERPRISE_LOCATION) { result -> result.onSuccess { enterpriseLocations -> } } ``` ## Enterprise Categories An EnterpriseCategory groups one or more EnterpriseLocation. These allow similar locations to be sorted in a logical fashion. For example a mall may group locations into Food Court, Footwear and Women's Fashion. They can be accessed using the MapData.getByType() method as shown below. ```kotlin mapView.mapData.getByType(MapDataType.ENTERPRISE_CATEGORY) { result -> result.onSuccess { enterpriseCategories -> } } ``` EnterpriseCategory can contain one or more sub EnterpriseCategory that are accessed from its `children` member. ## Enterprise Venue The EnterpriseVenue class holds metadata about the map, which includes the map name, supported languages, default language, top locations and more. It can be accessed using the MapData.getByType() method as shown below. ```kotlin mapView.mapData.getByType(MapDataType.ENTERPRISE_VENUE) { result -> result.onSuccess { enterpriseVenue -> } } ``` ## Search :::tip Note that the MapData class instantiates the Search class and exposes it as MapView.mapData.search. Use MapView.mapData.search to utilize Search' methods. ::: The Search functionality allows users to search for locations, categories, and other points of interest within the venue. :::tip A complete example demonstrating Search can be found in the Mappedin Android Github repo: SearchDemoActivity.kt ::: Here are two ways to enable search: 1. Enable Search on map initialization: ```kotlin // See Trial API key Terms and Conditions // https://developer.mappedin.com/docs/demo-keys-and-maps val options = GetMapDataWithCredentialsOptions( key = "5eab30aa91b055001a68e996", secret = "RJyRXKcryCMy4erZqqCbuB1NbR66QTGNXVE0x3Pg6oCIlUR1", mapId = "mappedin-demo-mall", search = SearchOptions(enabled = true) ) mapView.getMapData(options) { result -> ``` 2. Enable Search via method: ```kotlin mapView.mapData.search.enable { result -> result.onSuccess { runOnUiThread { setupSearch() } } } ``` ### Search Query Use Search.query to search for locations based on a string input: - EnterpriseLocationOptions: Specific places such as stores, restaurants, or washrooms. - EnterpriseCategoryOptions: Groups of locations, such as "Food Court" or "Electronics." - PlaceOptions: Any main objects that can be searched for such as Space, Door, PointOfInterest Search query returns a list of matching SearchResult based on the input string. SearchResult include information about the type of match, the score (relevance), and detailed metadata about the matching items. #### Example Search Query ```kotlin mapView.mapData.search.query(item.suggestion.suggestion) { result -> result.onSuccess { searchResult -> // Handle search results } } ``` ### Search Suggestions Use Search.suggest to fetch real-time suggestions based on partial input. This is useful for creating an autocomplete feature for a search bar. #### Example Code ```kotlin mapView.mapData.search.suggest(query) { result -> result.onSuccess { suggestions -> // Handle suggestions } } ``` :::tip A complete example demonstrating Search can be found in the Mappedin Android Github repo: SearchDemoActivity.kt ::: ### 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 ``` Ensure that hardware acceleration is not turned off by setting it to `true`. ```xml ``` Ensure that the application has a large heap by setting it to `true`. ```xml ``` ### 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.1.0-alpha.1' ``` #### libs.versions.toml ``` [versions] mappedin = "6.1.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 package com.mappedin.demo import android.os.Bundle import android.util.Log import android.view.Gravity import android.view.ViewGroup import android.widget.FrameLayout import android.widget.ProgressBar import androidx.appcompat.app.AppCompatActivity import com.mappedin.MapView import com.mappedin.models.GetMapDataWithCredentialsOptions import com.mappedin.models.Show3DMapOptions class DisplayMapDemoActivity : AppCompatActivity() { private lateinit var mapView: MapView private lateinit var loadingIndicator: ProgressBar override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) title = "Display a Map" // Create a FrameLayout to hold both the map view and loading indicator val container = FrameLayout(this) mapView = MapView(this) container.addView( mapView.view, ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, ), ) // Add loading indicator loadingIndicator = ProgressBar(this) val loadingParams = FrameLayout.LayoutParams( ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT, ) loadingParams.gravity = Gravity.CENTER container.addView(loadingIndicator, loadingParams) setContentView(container) // 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: ## Create a Key & Secret ## 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 ### Interactivity # Interactivity > This guide explains how to enhance a map's interactivity by making components clickable. Interactivity can greatly improve the user experience and user engagement with a map. :::tip A complete example demonstrating interactivity can be found in the Mappedin Android Github repo: InteractivityDemoActivity.kt ::: !Mappedin v6 Interactivity ## Interactive Spaces A Space can be set to interactive to allow a user to click on it. When interactivity is enabled for a space, it enables a hover effect that highlights the space when the cursor is moved over the space. The following code enables interactivity for all spaces: ```kotlin // Set all spaces to be interactive so they can be clicked mapView.mapData.getByType(MapDataType.SPACE) { result -> result.onSuccess { spaces -> spaces.forEach { space -> mapView.updateState(space, mapOf("interactive" to true)) { } } } } ``` ## Interactive Labels A Label added to the map can be set to interactive to allow users to click on it and have the click event captured by an app. The code sample below adds a label to each space with a name and sets the label's interactivity to true. ```kotlin // Set all spaces to be interactive so they can be clicked mapView.mapData.getByType(.space) { [weak self] (result: Result<[Space], Error>) in guard let self = self else { return } if case .success(let spaces) = result { spaces.forEach { space in self.mapView.updateState(target: space, state: ["interactive": true]) { _ in } } } } ``` After enabling interactivity, click events on the label can be captured using Mapview.on('click'). The Events object passed into the `on` method contains an array of labels that were clicked. The following code sample captures the click event and checks if the user clicked on a label. If they did, it logs the id of the label that was clicked and removes it from the map. ```kotlin mapView.on("click") { payload -> val click = payload as? ClickPayload val text = click?.labels?.firstOrNull()?.text text?.let { Log.d("MappedinDemo", "removing label: $it") } click?.labels?.firstOrNull()?.let { mapView.labels.remove(it) } } ``` ## Interactive Markers A Marker can be set to interactive, allowing it to be clickable and have an app act on the click event. The `interactive` property of a Marker can be set to `true`, `false` or `pointer-events-auto`. - `false` - The Marker is not interactive. - `true` - The Marker is interactive and the click event is captured by the `mapView.on('click')` event handler. - `pointer-events-auto` - The Marker is interactive and mouse events are passed to the Marker's HTML content. The code sample below adds a marker for each annotation and sets the marker's interactivity to true. ```kotlin mapView.mapData.getByType(com.mappedin.models.MapDataType.ANNOTATION) { r -> r.onSuccess { annotations -> val opts = AddMarkerOptions( interactive = AddMarkerOptions.Interactive.True, placement = AddMarkerOptions.Placement.Single(MarkerPlacement.CENTER), rank = AddMarkerOptions.Rank.Tier(CollisionRankingTier.HIGH), ) // Add markers for all annotations that have icons. annotations.forEach { annotation -> val iconUrl = annotation.icon?.url val markerHtml = """
${annotation.name}
""".trimIndent() mapView.markers.add(annotation, markerHtml, opts) { } } } } ``` After enabling interactivity, click events on the label can be captured using Mapview.on('click'). The Events object passed into the `on` method contains an array of markers that were clicked. The following code sample captures the click event and checks if the user clicked on a marker. If they did, it logs the id of the marker that was clicked and removes it from the map. ```kotlin // Remove markers that are clicked on. mapView.on("click") { payload -> val click = payload as? ClickPayload val clickedMarker = click?.markers?.firstOrNull() ?: return@on mapView.markers.remove(clickedMarker) { } } ``` ## Handling Click Events Mappedin SDK for Android enables capturing and responding to click events through its event handling system. After enabling interactivity, click events can be captured using Mapview.on('click'). The Events `click` event passes ClickPayload that contains the objects the user clicked on. It allows developers to obtain information about user interactions with various elements on the map, such as: 1. **coordinate** - A Coordinate object that contains the latitude and longitude of the point where the user clicked. 2. **facades** - An array of Facade objects that were clicked. 3. **floors** - An array of Floor objects. If the map contains multiple floors, floors under the click point are included. 4. **labels** - An array of Label objects that were clicked. 5. **markers** - An array of Marker objects that were clicked. 6. **models** - An array of Model objects that were clicked. 7. **objects** - An array of MapObject objects that were clicked. 8. **paths** - An array of Path objects that were clicked. 9. **pointerEvent** - A PointerEvent object that contains the pointer event data. 10. **shapes** - An array of Shape objects that were clicked. 11. **spaces** - An array of Space objects that were clicked. Use `Mapview.on('click')` to capture click events as shown below. ```kotlin // Set up click listener mapView.on(Events.CLICK) { event -> val clickPayload = event as? ClickPayload ?: return@on handleClick(clickPayload) } private fun handleClick(clickPayload: ClickPayload) { val title: String val message = StringBuilder() // Use the map name as the title (from floors) title = clickPayload.floors?.firstOrNull()?.name ?: "Map Click" // If a label was clicked, add its text to the message val labels = clickPayload.labels if (!labels.isNullOrEmpty()) { message.append("Label Clicked: ") message.append(labels.first().text) message.append("\n") } // If a space was clicked, add its location name to the message val spaces = clickPayload.spaces if (!spaces.isNullOrEmpty()) { val space = spaces.first() message.append("Space clicked: ") message.append(space.name) message.append("\n") } // If a path was clicked, add it to the message if (!clickPayload.paths.isNullOrEmpty()) { message.append("You clicked a path.\n") } // Add the coordinates clicked to the message message.append("Coordinate Clicked: \nLatitude: ") message.append(clickPayload.coordinate.latitude) message.append("\nLongitude: ") message.append(clickPayload.coordinate.longitude) Log.d("MappedinDemo", "title: $title, message: $message") } ``` :::tip A complete example demonstrating interactivity can be found in the Mappedin Android Github repo: InteractivityDemoActivity.kt ::: ### Labels # Labels > Labels display text and images anchored to specific points on a map. They rotate, show, or hide based on priority and zoom level, providing information about location names, points of interest, and more. Effective labels help apps convey additional information, such as room names, points of interest, main entrances, or other useful contextual details. :::tip A complete example demonstrating Labels can be found in the Mappedin Android Github repo: LabelsDemoActivity.kt ::: !Mappedin v6 Labels :::tip Note that the MapView class instantiates the Labels class and exposes it as MapView.labels. Use MapView.labels to utilize Labels' methods. ::: ## Adding & Removing Individual Labels Labels can be added individually to a map by calling Labels.add(). A label can be added to any Anchorable target. Refer to the Labels.add() documentation for the complete list of targets. The following code sample adds an interactive (clickable) label to each space that has a name: ```kotlin mapView.mapData.getByType(MapDataType.SPACE) { result -> result.onSuccess { spaces -> for (space in spaces) { if (space.name.isNotEmpty()) { val color = colors.random() val appearance = LabelAppearance( color = color, icon = space.images.firstOrNull()?.url ?: svgIcon, ) mapView.labels.add( target = space, text = space.name, options = AddLabelOptions(labelAppearance = appearance, interactive = true), ) } } } } ``` Labels can be removed by using the Labels.remove(label) method, passing in the label to be removed as shown below: ```kotlin mapView.labels.remove(label) ``` ## Interactive Labels Labels added to the map can be set to interactive to allow users to click on them. For more information, refer to the Interactive Labels section of the Interactivity Guide. ## Label Icons Icons can be added to labels in `SVG`, `PNG`, `JPEG` and `WebP` formats. Icons are clipped in a circle to prevent overflow. Three clipping methods of `contain`, `fill` and `cover` can be set in the LabelAppearance.iconFit parameter with `contain` being the default. | Fill | Contain | Cover (default) | | ----------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------- | | !Floating Label fill | !Floating Label contain | !Floating Label cover | The LabelAppearance.iconPadding property sets the amount of space between the icon and the border. The icon may shrink based on this value. | `padding: 0` | `padding: 10` | | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | !Floating Label fill with 0 padding | !Floating Label fill with 10 padding | Label icons can be configured to be shown or hidden based on the current zoom level using LabelAppearance.iconVisibleAtZoomLevel. A value below 0 will result in the icon always being hidden. Setting this value to 0 ensures icons show up at maxZoom (fully zoomed in) and 1 configures them to always be displayed. ## Label Appearance Labels can have their appearance styled to match the visual theme of an app or to make groups of labels easily distinguishable from one another. The following declaration of LabelAppearance describes these customisable attributes. | Option | Type | Description | Default | |--------|------|-------------|---------| | `margin` | `number` | Margin around the label text and pin in pixels. This will affect label density. Minimum is 6px. | 6 | | `maxLines` | `number` | Number of lines to display when text spans multiple lines. | 2 | | `textSize` | `number` | Text size in pixels | 11.5 | | `maxWidth` | `number` | Maximum width of text in pixels. | 150 | | `lineHeight` | `number` | Line height sets the height of a line box. It's commonly used to set the distance between lines of text. | 1.2 | | `color` | ColorString | A ColorString for the label text and pin. | `#333` | | `outlineColor` | ColorString | A ColorString for the outline around the label text and pin. | `white` | | `textColor` | ColorString | A ColorString representing just the text color. Defaults to the same as `color`. | - | | `textOutlineColor` | ColorString | A ColorString representing just the text outline. Defaults to the same as `outlineColor`. | - | | `pinColor` | ColorString | A ColorString representing just the pin color. Defaults to the same as `color`. | - | | `pinOutlineColor` | ColorString | A ColorString representing just the pin outline. Defaults to the same as `outlineColor`. | - | | `pinColorInactive` | ColorString | A ColorString representing just the pin color when the label is inactive. Defaults to the same as `pinColor`. | - | | `pinOutlineColorInactive` | ColorString | A ColorString representing just the pin outline when the label is inactive. Defaults to the same as `pinOutlineColor`. | - | | `icon` | `string` | An icon to be placed inside the label pin. Can be an SVG string or a path to a PNG or JPEG. | - | | `iconSize` | `number` | Size of the icon in pixels. Requires `icon` to be set. | 20 | | `iconScale` | `number` \| Interpolation | Scale the icon uniformly. Specify a number or an Interpolation object. | 1 | | `iconPadding` | `number` | Padding between the icon and the marker's border in pixels. | 2 | | `iconFit` | `'fill'` \| `'contain'` \| `'cover'` | How the icon should fit inside the marker. Options: `fill` (stretch to fill), `cover` (maintain aspect ratio and fill), `contain` (maintain aspect ratio and fit inside). | `cover` | | `iconOverflow` | `'visible'` \| `'hidden'` | Whether the icon should overflow the circle of the marker. Options: `visible`, `hidden`. | `hidden` | | `iconVisibleAtZoomLevel` | `number` | Defines the zoom level at which the icon becomes visible. Infinity ensures never visible, -Infinity ensures always visible. | -Infinity | The code sample below demonstrates how to use some label styling options. Labels are added to each space with a name using the space's image if one is set, or a default SVG icon if one is not. It also sets the label text color to a random color from a list of colors. ```kotlin val svgIcon = """ """.trimIndent() val colors = listOf("#FF610A", "#4248ff", "#891244", "#219ED4") mapView.mapData.getByType(MapDataType.SPACE) { result -> result.onSuccess { spaces -> for (space in spaces) { if (space.name.isNotEmpty()) { val color = colors.random() val appearance = LabelAppearance( color = color, icon = space.images.firstOrNull()?.url ?: svgIcon, ) mapView.labels.add( target = space, text = space.name, options = AddLabelOptions(labelAppearance = appearance, interactive = true), ) } } } } ``` ## Label Ranking Ranking can be added to labels to control which label will be shown when more than one label occupies the same space. The label with the highest rank will be shown. If labels do not overlap, ranking will have no effect. Rank values are low, medium, high, and always-visible and are defined in CollisionRankingTier. The code below add a label with a high ranking where a user clicks on the map. ```kotlin mapView.on(Events.CLICK) { event -> val clickPayload = event as? ClickPayload ?: return@on mapView.labels.add( target = clickPayload.coordinate, text = "I'm a high ranking label!", options = AddLabelOptions(rank = CollisionRankingTier.HIGH), ) } ``` ## Enabling and Disabling Labels Labels can be dynamically enabled or disabled using `mapView.updateState()`. When a label is disabled, it will be hidden from view but remain in the map's memory. This is useful for managing label visibility based on conditions like zoom level or user interaction, without the overhead of repeatedly adding and removing labels. For Mappedin JS, use `mapView.getState()` to check a label's current state, which returns the label's current properties including its enabled status. Here's an example on how to enable/disable labels on click: ```kotlin private var label: Label? = null ... mapView.on(Events.CLICK) { event -> val clickPayload = event as? ClickPayload ?: return@on if (label == null) { // Add the label if it doesn't exist. mapView.labels.add( target = clickPayload.coordinate, text = "Click to Toggle", onResult = { it.onSuccess { label = it } }, ) } else { // Toggle the label. label?.let { currentLabel -> mapView.getState( currentLabel, onResult = { result -> result.onSuccess { state -> Log.d("SOHM", state.toString()) state?.let { mapView.updateState( currentLabel, LabelUpdateState(enabled = !it.enabled), ) } } }, ) } } } ``` :::tip A complete example demonstrating Labels can be found in the Mappedin Android Github repo: LabelsDemoActivity.kt ::: ### Location Profiles & Categories # Location Profiles & Categories > A Location refers to something that represents a physical position on the map, such as an annotation, area, connection (e.g. stairs or elevator), door, point of interest or space. Locations may have a LocationProfile attached to them. The profiles contain information about the location such as its name, description, social media links, opening hours, logo and more. A LocationProfile can have zero to many LocationCategory attached to it. A LocationCategory may have a child or parent category. For example, the parent `Food & Drink` LocationCategory has children such as `Bar`, `Cafe`, `Food Court` and `Mediterranean Cuisine`. !Location Profiles & Categories :::tip A complete example demonstrating location profiles and categories can be found in the Mappedin Android Github repo: LocationsDemoActivity.kt ::: ## LocationProfile A LocationProfile can be accessed by using the `locationProfiles` property of a location. For example, use Space.locationProfiles to access every LocationProfile of a space. Every LocationProfile can also be access using the MapData.getByType() method as shown below. ```kotlin mapView.mapData.getByType(MapDataType.LOCATION_PROFILE) { result -> result.onSuccess { locationProfiles -> } } ``` ## LocationCategory To access the LocationCategory of a LocationProfile, use the LocationProfile.categories property, which contains a list of IDs of its LocationCategory. Then use the MapData.getById() method to get the LocationCategory by its ID. Note that a LocationCategory can have either parent or child categories. These are accessible using the LocationCategory.parent and LocationCategory.children properties respectively. Every LocationCategory can also be access using the MapData.getByType() method as shown below. ```kotlin mapView.mapData.getByType(MapDataType.LOCATION_CATEGORY) { result -> result.onSuccess { locationCategories -> } } ``` :::tip A complete example demonstrating location profiles and categories can be found in the Mappedin Android Github repo: LocationsDemoActivity.kt ::: ### Markers # Markers > Mappedin SDK for Android allows adding and removing Marker on a map. Markers are elements containing HTML that the Mappedin SDK anchors to any Anchorable target. They are automatically rotated and repositioned when the camera moves. :::tip A complete example demonstrating Markers can be found in the Mappedin Android Github repo: MarkersDemoActivity.kt ::: !Mappedin JS v6 Markers :::tip Note that the MapView class instantiates the Markers class and exposes it as MapView.markers. Use MapView.markers to utilize Markers' methods. ::: ## Creating Markers Markers are added to the map by referencing a target that can be a Door, Space, Coordinate or any Anchorable target. The following code sample adds a marker to a coordinate. ```kotlin val opts = AddMarkerOptions( interactive = AddMarkerOptions.Interactive.True, placement = AddMarkerOptions.Placement.Single(MarkerPlacement.CENTER), rank = AddMarkerOptions.Rank.Tier(CollisionRankingTier.HIGH), ) val markerHtml = """
This is a Marker!
""".trimIndent() mapView.markers.add(coordinate, markerHtml, opts) { } ``` ## Placement Marker placement is set using the `options` argument of Markers.add(). Options accepts a AddMarkerOptions value, which has a member named `placement`. When provided, the point of the Marker described by the Placement is placed next to the target. For example, using `MarkerPlacement.CENTER` will place the Marker's center at the target. Both a single placement and an array of placements can be provided. When an array is provided, the Marker is placed at the first target that has space available to display the Marker. Placement positions are defined in MarkerPlacement which contains 9 values. The placement points are as follows, with the default being center. ### MarkerPlacement - `CENTER` - `TOP` - `LEFT` - `BOTTOM` - `RIGHT` - `top-left` - `TOP_RIGHT` - `BOTTOM_LEFT` - `BOTTOM_RIGHT` Marker content can be styled using CSS that references the placement of the marker. This can allow the creation of a tooltip or bubble-style marker that points to its target. This is done by using the CSS Selector: ```css .mappedin-marker[data-placement='']; ``` Where `` is the placement position. Here is an example of adding a triangle pointer to the Marker's target of `left`: ```CSS .marker:before { content: ''; width: 0; height: 0; top: calc(50% - 10px); left: -10px; z-index: 1; position: absolute; border-bottom: 10px solid transparent; border-top: 10px solid transparent; z-index: -1; } .mappedin-marker[data-placement="left"] .marker:before { left: auto; right: -5px; border-left: 10px solid #333333; } ``` ## Removing Markers Markers can be removed individually by using the Markers.remove(marker) method, passing in the marker to be removed as shown below. ```kotlin mapView.markers.remove(marker) { } ``` To remove all markers from a map, call Markers.removeAll(). ```kotlin mapView.markers.removeAll() { } ``` ## Marker Rank Ranking can be added to markers to control which marker will be shown when more than one marker occupies the same space. The marker with the highest rank will be shown. If markers do not overlap, ranking will have no effect. Rank values low, medium, high and always-visible as defined in CollisionRankingTier. The code below adds markers where a user clicks on the map. The marker rank is cycled with each click. If the user clicks and adds multiple markers in the same location, the marker with the highest rank is shown and lower ranking markers are hidden. ```kotlin // Ranks for marker collision priority - cycles through medium, high, always-visible private val ranks = listOf(CollisionRankingTier.MEDIUM, CollisionRankingTier.HIGH, CollisionRankingTier.ALWAYS_VISIBLE) private var rankIndex = 0 ... // Act on the click event and add a marker with a cycling rank. // Observe how higher ranking markers are shown when they collide with lower ranking markers. mapView.on(Events.CLICK) { event -> val clickPayload = event as? ClickPayload ?: return@on val currentRank = ranks[rankIndex] val rankName = currentRank.value val markerTemplate = """

Marker Rank: $rankName

""".trimIndent() // Add a marker with the current rank at the clicked coordinate. mapView.markers.add( target = clickPayload.coordinate, html = markerTemplate, options = AddMarkerOptions(rank = AddMarkerOptions.Rank.Tier(currentRank)) ) // Cycle to the next rank rankIndex++ if (rankIndex == ranks.size) { rankIndex = 0 } } ``` ## Moving Markers Markers can be repositioned after they have been added to a map. There are two ways of doing this: - Markers.setPosition() instantly repositions a Marker - Markers.animateTo() animates a Marker to a new position The Marker's position can be set to a Coordinate, Space or Door. The `animateTo` method takes an `options` parameter of AnimationOptions that defines the animation duration and EasingFunction, which can be EasingFunction.LINEAR, EasingFunction.EASE_IN, EasingFunction.EASE_OUT or EasingFunction.EASE_IN_OUT. - **Linear**: This function implies a constant rate of change. It means the animation proceeds at the same speed from start to end. There's no acceleration or deceleration, giving a very mechanical feel. - **Ease In**: This function causes the animation to start slowly and then speed up as it progresses. Initially, there's gradual acceleration, and as the function moves forward, the rate of change increases. - **Ease Out**: Contrary to ease-in, ease-out makes the animation start quickly and then slow down towards the end. It begins with a faster rate of change and gradually decelerates. - **Ease In Out**: This function combines both ease-in and ease-out. The animation starts slowly, speeds up in the middle, and then slows down again towards the end. It offers a balance of acceleration and deceleration. The code samples below displays a custom Marker when the map is first clicked. When the map is clicked again, the Marker is animated to the clicked location using the default animation options. ```kotlin private var marker: Marker? = null ... mapView.on(Events.CLICK) { payload -> val click = payload as? ClickPayload ?: return@on val coordinate = click.coordinate if (marker != null) { // Animate existing marker to new position mapView.markers.animateTo(marker!!, coordinate) } else { // Add new marker at clicked position val options = AddMarkerOptions( interactive = AddMarkerOptions.Interactive.True, placement = AddMarkerOptions.Placement.Single(MarkerPlacement.RIGHT) ) mapView.markers.add(coordinate, "Marker", options) { result -> result.onSuccess { newMarker -> marker = newMarker } } } } ``` ## Enabling and Disabling Markers Markers can be dynamically enabled or disabled using MapView.updateState(). When a marker is disabled, it will be hidden from view but remain in the map's memory. This is useful for managing marker visibility based on conditions like zoom level or user interaction, without the overhead of repeatedly adding and removing markers. Use MapView.getState() to check a marker's current state, which returns the marker's current properties including its enabled status. Here's an example on how to enable/disable markers on click: ```kotlin private var marker: Marker? = null ... mapView.on(Events.CLICK) { payload -> val click = payload as? ClickPayload ?: return@on val coordinate = click.coordinate if (marker == null) { // First click - add marker Log.d("MappedinDemo", "Adding marker at: $coordinate") mapView.markers.add( coordinate, "
Enabled Marker!
" ) { result -> result.onSuccess { newMarker -> marker = newMarker } } } else { // Get current state of marker mapView.getState(marker!!) { result -> result.onSuccess { markerState -> Log.d("MappedinDemo", "Current Marker State: $markerState") // Toggle enabled state val newState = !(markerState?.enabled ?: true) mapView.updateState(marker!!, MarkerUpdateState(enabled = newState)) Log.d("MappedinDemo", "Marker is now ${if (newState) "enabled" else "disabled"}") } } } } ``` :::tip A complete example demonstrating Markers can be found in the Mappedin Android Github repo: MarkersDemoActivity.kt ::: ### Points of Interest # Points of Interest > Points of Interest (POIs) are specific locations or features on a map that users find useful or informative. POIs serve as landmarks or markers, highlighting key places, services, or objects to enhance the map's utility and user experience. They are contained in the PointOfInterest class, which contains a coordinate, name, description, images, links and the floor the point of interest exists on. All of these elements are configured in Mappedin Maker. !Mappedin JS v6 POIs PointOfInterest.name could be used to create labels to show users helpful information. The following sample code demonstrates one possible use for PointOfInterest. It labels each PointOfInterest and uses Camera.animateTo() to create a flyby of each one. ```kotlin package com.mappedin.demo import android.os.Bundle import android.os.Handler import android.os.Looper import android.util.Log import android.view.Gravity import android.view.ViewGroup import android.widget.FrameLayout import android.widget.ProgressBar import androidx.appcompat.app.AppCompatActivity import com.mappedin.MapView import com.mappedin.models.Annotation import com.mappedin.models.Area import com.mappedin.models.CameraAnimationOptions import com.mappedin.models.CameraTarget import com.mappedin.models.Connection import com.mappedin.models.Door import com.mappedin.models.EasingFunction import com.mappedin.models.EnterpriseCategory import com.mappedin.models.EnterpriseLocation import com.mappedin.models.EnterpriseVenue import com.mappedin.models.Facade import com.mappedin.models.Floor import com.mappedin.models.FloorStack import com.mappedin.models.GetMapDataWithCredentialsOptions import com.mappedin.models.LocationCategory import com.mappedin.models.LocationProfile import com.mappedin.models.MapDataType import com.mappedin.models.MapObject import com.mappedin.models.Node import com.mappedin.models.PointOfInterest import com.mappedin.models.Show3DMapOptions import com.mappedin.models.Space import kotlin.math.atan2 import kotlin.math.cos import kotlin.math.floor import kotlin.math.sin class DisplayMapDemoActivity : AppCompatActivity() { private lateinit var mapView: MapView private lateinit var loadingIndicator: ProgressBar override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) title = "Display a Map" // Create a FrameLayout to hold both the map view and loading indicator val container = FrameLayout(this) mapView = MapView(this) container.addView( mapView.view, ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, ), ) // Add loading indicator loadingIndicator = ProgressBar(this) val loadingParams = FrameLayout.LayoutParams( ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT, ) loadingParams.gravity = Gravity.CENTER container.addView(loadingIndicator, loadingParams) setContentView(container) // 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 = "65c0ff7430b94e3fabd5bb8c", ) // 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") val animationDuration = 4000 // Get the map center as the starting point for bearing calculations. mapView.mapData.mapCenter { centerResult -> centerResult.onSuccess { mapCenter -> if (mapCenter == null) { Log.e("MappedinDemo", "Map center is null") return@onSuccess } // Get all points of interest. mapView.mapData.getByType(MapDataType.POINT_OF_INTEREST) { result -> result.onSuccess { pois -> // Start iterating through POIs with initial position from map center. animateThroughPOIs( mapView = mapView, pois = pois, index = 0, startLat = mapCenter.latitude, startLon = mapCenter.longitude, animationDuration = animationDuration, ) } result.onFailure { error -> Log.e("MappedinDemo", "Failed to get POIs: $error") } } } centerResult.onFailure { error -> Log.e("MappedinDemo", "Failed to get map center: $error") } } } /** * Recursively animates through each point of interest. */ private fun animateThroughPOIs( mapView: MapView, pois: List, index: Int, startLat: Double, startLon: Double, animationDuration: Int, ) { if (index >= pois.size) { Log.d("MappedinDemo", "Finished animating through all POIs") return } val poi = pois[index] // Label the point of interest. mapView.labels.add(target = poi.coordinate, text = poi.name) // Calculate the bearing between the current position and the POI. val bearing = calcBearing( startLat, startLon, poi.coordinate.latitude, poi.coordinate.longitude, ) // Animate to the current point of interest. mapView.camera.animateTo( target = CameraTarget( bearing = bearing, pitch = 80.0, zoomLevel = 50.0, center = poi.coordinate, ), options = CameraAnimationOptions( duration = animationDuration, easing = EasingFunction.EASE_OUT, ), ) // Wait for the animation to complete before moving to the next POI. Handler(Looper.getMainLooper()).postDelayed({ animateThroughPOIs( mapView = mapView, pois = pois, index = index + 1, startLat = poi.coordinate.latitude, startLon = poi.coordinate.longitude, animationDuration = animationDuration, ) }, animationDuration.toLong()) } /** * Calculate the bearing between two points. */ private fun calcBearing( startLat: Double, startLng: Double, destLat: Double, destLng: Double, ): Double { val startLatRad = toRadians(startLat) val startLngRad = toRadians(startLng) val destLatRad = toRadians(destLat) val destLngRad = toRadians(destLng) val y = sin(destLngRad - startLngRad) * cos(destLatRad) val x = cos(startLatRad) * sin(destLatRad) - sin(startLatRad) * cos(destLatRad) * cos(destLngRad - startLngRad) var brng = atan2(y, x) brng = toDegrees(brng) return (brng + 360) % 360 } /** Converts from degrees to radians. */ private fun toRadians(degrees: Double): Double = degrees * Math.PI / 180 /** Converts from radians to degrees. */ private fun toDegrees(radians: Double): Double = radians * 180 / Math.PI } ``` ### 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. { // Release notes template: // https://keepachangelog.com/en/1.0.0/#how // ## vXX.XX.XX - Month Day, Year // _ Added // _ Changed // _ Deprecated // _ Removed // _ Fixed // _ Security } ## 6.1.0-alpha.1 - December 19, 2025 - Added - LabelAppearance.iconScale property to control the scale of the icon. - Fixed - `MapData.getById` not returning the correct type. ### ⚠️ Breaking Changes - Fixed - Removed duplicate inline implementation of Interpolation and Width. ```kotlin // ❌ Before AddPathOptions( width = AddPathOptions.Width.Fixed(1.0), ) // ✅ After AddPathOptions( width = Width.Value(1.0), ) ``` - Fixed - `MapView.getState` and `MapView.updateState` should use data classes and not plain objects. ```kotlin // ❌ Before mapView.updateState(space, mapOf("interactive" to true)) { } // ✅ After mapView.updateState(space, GeometryUpdateState(interactive = true)) { } ``` ## 6.0.0-alpha.1 - December 4, 2025 - Upgraded to Mappedin JS v6.7.0. ## 6.0.0-alpha.0 - December 3, 2025 - Initial release of Mappedin SDK for Android v6. ### Spaces # Spaces > A Space represents an area enclosed by walls, such as a hall or room. Spaces can be Interactive and have Labels and Markers added to them. Spaces can also be customized with a color and texture. ## Spaces Example The example below loops through all spaces and makes them interactive. Refer to the Textures & Colors (coming soon) section for more information on how to set the texture or color of a space. ```kotlin // Set all spaces to be interactive so they can be clicked mapView.mapData.getByType(MapDataType.SPACE) { result -> result.onSuccess { spaces -> spaces.forEach { space -> mapView.updateState(space, mapOf("interactive" to true)) { } } } } ``` ## Doors By default, a Door is not visible and drawn as a gap in a wall. An app can set the `visible` property to `true` to make the door visible. Other properties of a door can also be set, such as color, texture, interactivity and more. Refer to DoorsState for the complete list of properties. Refer to the Textures & Colors (coming soon) section for more information on how to set the texture or color of a door. Doors are grouped into DOORS.Interior and DOORS.Exterior doors, based on whether they are on an interior or exterior wall. ```kotlin // Make interior doors visible and brown. mapView.updateState( Doors.INTERIOR.value, mapOf( "visible" to true, "color" to "#5C4033", "opacity" to 0.6, ), ) { } // Make exterior doors visible and black. mapView.updateState( Doors.EXTERIOR.value, mapOf( "visible" to true, "color" to "black", "opacity" to 0.6, ), ) { } ``` The screenshot below shows brown interior and black exterior doors with labels added to depict the status of the door. !Visible Doors