Toolkit

ArcGIS Maps SDK for Kotlin offers a toolkit, ArcGIS Maps SDK for Kotlin Toolkit, that contains composable UI components to help simplify your Android development work. For information on how Android Jetpack Compose works, see Get started with Jetpack Compose.

The GeoView-Compose module has composable components to display maps and scenes. Most apps that use Android Jetpack Compose will need this module.

• GeoView-Compose - Contains the composable components MapView, SceneView and LocalSceneView, which are wrappers for the MapView, SceneView and LocalSceneView classes in the Kotlin Maps SDK API.

The Toolkit contains other, special-purpose composable components:

• Augmented Reality - FlyoverSceneView - Allows you to explore a scene using your device as a window into the virtual world.
• Augmented Reality - TableTopSceneView - Allows you to anchor scene content to a physical surface, as if it were a 3D-printed model.
• Augmented Reality - WorldScaleSceneView - Allows you to integrate scene content with the real world features like streets and buildings.
• Authenticator - Displays a user interface when network and ArcGIS authentication challenges occur.
• BasemapGallery - Provides a control for selecting basemaps.
• Compass - Shows a compass direction when the map is rotated. Auto-hides when the map points north.
• FeatureForm - Enables users to edit field values of a feature using pre-configured forms.
• FloorFilter - Allows filtering of floor plan data in a GeoView by a site, a facility in the site, or a floor in the facility.
• GeoView-Compose Callout - Draws a callout on the GeoView to display Composable content.
• GeoView-Compose OverviewMap - Displays the visible extent of a GeoView in a small "inset" map.
• Legend - Displays a legend for a map or a scene.
• OfflineMapAreas - Allows you to take a web map offline by downloading map areas.
• Popup - View field values of features in a layer using the Popup API.
• Scalebar - Displays current scale reference.
• UtilityNetworkTrace - Configure, run, and visualize UtilityNetworkTraces on a composable MapView.

The fastest way to get the toolkit into your app is to reference the compiled library (.aar file) from Jfrog, as described below. For instructions on using the toolkit from source code — for example, if you want to customize it — see Developer setup in the toolkit's repo.

Modular toolkit library

The toolkit has library modules that can be deployed independent of each other in an application. Note that an individual library module can contain one or more composable UI components.

Reference the library from Jfrog

1. If you haven't already, install and set up ArcGIS Maps SDK for Kotlin.

2. Ensure the Esri public Jfrog Maven repository is in your project's gradle file, https://esri.jfrog.io/artifactory/arcgis

   settings.gradle.kts (Project Settings)

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   dependencyResolutionManagement {
   	repositories {
   		...
   		 maven { url = uri("https://esri.jfrog.io/artifactory/arcgis") }
   		...
   	}
   }

3. From the Android view, open Gradle Scripts > build.gradle.kts (Module: app) and add a dependency for each component of the ArcGIS Maps SDK for Kotlin Toolkit that you will be using.

   From the Project tool window, open Gradle Scripts > libs.versions.toml. In the [versions] section, verify you're using the correct version number for ArcGIS Maps SDK for Kotlin. And in the [libraries] section, add the library declarations for the following:

   • the ArcGIS Maps SDK for Kotlin SDK.
   • the ArcGIS Maps SDK for Kotlin Toolkit BOM.
   • any Toolkit components needed. For example, to display a simple map or scene, you need only the geoview-compose component, which contains the composable functions MapView and SceneView.
   Gradle version catalogs

   Gradle version catalogs are the standard Android approach to declaring dependency versions. They are preferred over specifying versions numbers in the build.gradle.kts or listing version numbers in a version.gradle. In recent releases of Android Studio, the New Project Wizard generates build.gradle.kts and gradle/libs.versions.toml files that support this standard.

   Gradle version catalogs can also use BOM files to specify a single version number for all artifacts in the BOM. For more details, see Using the BOM in the README of the ArcGIS Maps SDK for Kotlin Toolkit.

   build.gradle.kts (Module: app)gradle/libs.versions.toml
   Expand

   Use dark colors for code blocksCopy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
       // ArcGIS Maps for Kotlin - SDK dependency
       implementation(libs.arcgis.maps.kotlin)
       // Toolkit dependencies
       implementation(platform(libs.arcgis.maps.kotlin.toolkit.bom))
       implementation(libs.arcgis.maps.kotlin.toolkit.geoview.compose)
       implementation(libs.arcgis.maps.kotlin.toolkit.authentication)
   

   Expand

The highlights above indicate lines that we are adding to the default build.gradle.kts (Module: app) and gradle/libs.versions.toml generated by the Android Studio New Project Wizard.

The first time you build a project, the Gradle build script will automatically download the ArcGIS Maps SDK for Kotlin and its resources to your development machine. Your Android Studio project will then access the Kotlin Maps SDK with no further action on your part.

Build from source

Although not required to do so, you can build the Toolkit components and micro-apps from the source code in the Toolkit repo. See the setup instructions for details.

Requirements

The following table shows version compatibility.

SDK Version	Toolkit Version
300.0.0	300.0.0

Issues

Find a bug or want to request a new feature enhancement? Please let us know by submitting an issue.