Learn how to create and display a map from a web map stored in ArcGIS.
A web map contains the definition of a map, including properties such as the basemap, initial extent, layers, styles, pop-ups, and labels. You can author and save web maps using the Map Viewer or ArcGIS Pro and share them in ArcGIS. Each web map is stored as an item in ArcGIS Online or ArcGIS Enterprise, allowing you to access a web map from a portal using its item ID and display it in your app.
In this tutorial, you use a web map's item ID to display a map of trails, trailheads and parks in the Santa Monica Mountains . The web map is hosted in ArcGIS Online.
Prerequisites
The following are required for this tutorial:
- An ArcGIS account to access API keys. If you don't have an account, sign up for free.
- A development and deployment environment that meets the system requirements.
- An IDE for Android development in Kotlin.
Steps
Open an Android Studio project
-
To start this tutorial, complete the Display a map tutorial. Or download and unzip the Display a map solution in a new folder.
-
Modify the old project for use in this new tutorial. Expand More info for instructions.
-
On your file system, delete the .idea folder, if present, at the top level of your project.
-
In the Android tool window, open app > res > values > strings.xml.
In the
<string name="app_
element, change the text content to Display a web map.name"> strings.xmlUse dark colors for code blocks Change line <resources> <string name="app_name">Display a web map</string> </resources>
-
In the Android tool window, open Gradle Scripts > settings.gradle.
Change the value of
root
to Display a web map.Project.name settings.gradleUse dark colors for code blocks Change line rootProject.name = "Display a web map" include ':app'
-
Click File > Sync Project with Gradle files. Android Studio will recognize your changes and create a new .idea folder.
-
-
If you downloaded the solution project, set your API key.
An API Key enables access to services, web maps, and web scenes hosted in ArcGIS Online.
-
Go to your developer dashboard to get your API key. For these tutorials, use your default API key. It is scoped to include all of the services demonstrated in the tutorials.
-
In Android Studio: in the Android tool window, open app > java > com.example.app > MainActivity.
-
In the
set
function, find theA p i Key() ApiKey.create()
call and paste your API key inside the quotes, replacing YOUR_API_KEY.MainActivity.ktUse dark colors for code blocks private fun setApiKey() { // It is not best practice to store API keys in source code. We have you insert one here // to streamline this tutorial. ArcGISEnvironment.apiKey = ApiKey.create("YOUR_API_KEY") }
-
Get the web map item ID
You can use ArcGIS tools to create and view web maps. Use the Map Viewer to identify the web map item ID. This item ID will be used later in the tutorial.
- Go to the LA Trails and Parks web map in the Map Viewer in ArcGIS Online. This web map displays trails, trailheads and parks in the Santa Monica Mountains.
- Make a note of the item ID at the end of the browser's URL. The item ID should be
41281c51f9de45edaf1c8ed44bb10e30
Add import statements
-
Replace app-specific import statements with the imports needed for this tutorial. Copy the imports highlighted in yellow below into your
Main
.Activity.kt MainActivity.ktUse dark colors for code blocks package com.example.app import androidx.appcompat.app.AppCompatActivity import android.os.Bundle import android.util.Log import android.widget.Toast import androidx.databinding.DataBindingUtil import com.arcgismaps.ApiKey import com.arcgismaps.ArcGISEnvironment import com.arcgismaps.mapping.ArcGISMap import com.arcgismaps.mapping.view.MapView import com.arcgismaps.portal.Portal import com.arcgismaps.mapping.PortalItem import com.example.app.databinding.ActivityMainBinding class MainActivity : AppCompatActivity() {
Display the web map
You can create a map from a web map using the web map's item ID. Use the PortalItem
class to access the web map, and the ArcGISMap
class to create and display a map from it.
-
Delete the code inside the
setup
method. These lines come from the Display a map tutorial and do not apply here.Map MainActivity.ktUse dark colors for code blocks Remove line Remove line Remove line Remove line Remove line Remove line private fun setupMap() { val map = ArcGISMap(BasemapStyle.ArcGISTopographic) // set the map to be displayed in the layout's MapView mapView.map = map mapView.setViewpoint(Viewpoint(34.0270, -118.8050, 72000.0)) }
-
Create a new
Portal
referencing ArcGIS Online as theurl
parameter andAnonymous
for thePortal.Connection
parameter.MainActivity.ktUse dark colors for code blocks Add line. private fun setupMap() { val portal = Portal("https://www.arcgis.com", Portal.Connection.Anonymous) }
-
Create a
PortalItem
for the web map, by passing theportal
and the web map's item ID as parameters. -
Create an
ArcGISMap
using theitem
as the constructor parameter.MainActivity.ktUse dark colors for code blocks Add line. Add line. Add line. val portal = Portal("https://www.arcgis.com", Portal.Connection.Anonymous) val itemId = "41281c51f9de45edaf1c8ed44bb10e30" val portalItem = PortalItem(portal, itemId) val map = ArcGISMap(portalItem)
-
Set the
map
property ofmap
to theView ArcGISMap
you just created.MainActivity.ktUse dark colors for code blocks Add line. private fun setupMap() { val portal = Portal("https://www.arcgis.com", Portal.Connection.Anonymous) val itemId = "41281c51f9de45edaf1c8ed44bb10e30" val portalItem = PortalItem(portal, itemId) val map = ArcGISMap(portalItem) mapView.map = map }
-
Click Run > Run > app to run the app.
You should see a map of trails, trailheads and parks in the Santa Monica Mountains . Drag, swipe, or pinch on the map view to explore the map.
What's next?
Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials: