Display a web map

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

Steps

Open an Android Studio project

1. To start this tutorial, complete the Display a map tutorial. Or download and unzip the Display a map solution in a new folder.

2. Modify the old project for use in this new tutorial. Expand More info for instructions.

   More info

   1. On your file system, delete the .idea folder, if present, at the top level of your project.

   2. In the Android tool window, open app > res > values > strings.xml.

      In the <string name="app_name"> element, change the text content to Display a web map.

      strings.xml

      Use dark colors for code blocks

      1 2 3 4 5

      Change line

      1
      2
      3
      4
      5
      <resources>
      
          <string name="app_name">Display a web map</string>
      
      </resources>

   3. In the Android tool window, open Gradle Scripts > settings.gradle.

      Change the value of rootProject.name to Display a web map.

      settings.gradle

      Expand

      Use dark colors for code blocks

      19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 19 20 21 22

      Change line

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      rootProject.name = "Display a web map"
      
      include ':app'

   4. Click File > Sync Project with Gradle files. Android Studio will recognize your changes and create a new .idea folder.

3. If you downloaded the solution project, set your API key.

   More info

   An API Key enables access to services, web maps, and web scenes hosted in ArcGIS Online.

   1. 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.

   2. In Android Studio: in the Android tool window, open app > java > com.example.app > MainActivity.

   3. In the setApiKey() function, find the ApiKey.create() call and paste your API key inside the quotes, replacing YOUR_API_KEY.

      MainActivity.kt

      Use dark colors for code blocks

                                                                                     

      Change line

      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
      73
      74
      75
      76
      77
      78
      79
          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.

1. 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.
2. Make a note of the item ID at the end of the browser's URL. The item ID should be 41281c51f9de45edaf1c8ed44bb10e30

Add import statements

1. Replace app-specific import statements with the imports needed for this tutorial. Copy the imports highlighted in yellow below into your MainActivity.kt.

   MainActivity.kt

   Use dark colors for code blocks

                                                                                 

   Change lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange line

   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
   73
   74
   75
   76
   77
   78
   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.

1. Delete the code inside the setupMap method. These lines come from the Display a map tutorial and do not apply here.

   MainActivity.kt

   Use dark colors for code blocks

   54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 54 55 56 57 58 59 60 61 62 63 64 64 64 64 64 64 64 64 64 64 64 64 64 64 64 64

   Remove lineRemove lineRemove lineRemove lineRemove lineRemove line

   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
   73
   74
   75
   76
   77
   78
   79
       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))
   
       }
   

2. Create a new Portal referencing ArcGIS Online as the url parameter and Anonymous for the Portal.Connection parameter.

   MainActivity.kt

   Expand

   Use dark colors for code blocks

   53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 54 55 56 57 57 57 57 57 57 57 58 58 58 58 58 58 58 58 58 58 58 58 58 58 58

   Add line.

   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
   73
   74
   75
   76
   77
   78
       private fun setupMap() {
   
           val portal = Portal("https://www.arcgis.com", Portal.Connection.Anonymous)
   
       }
   

   Expand

3. Create a PortalItem for the web map, by passing the portal and the web map's item ID as parameters.

4. Create an ArcGISMap using the item as the constructor parameter.

   MainActivity.kt

   Expand

   Use dark colors for code blocks

   55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 55 56 57 58 59 60 60 59 58 58 58 58 58 58 58 58 58 58 58 58 58 58 58 58

   Add line.Add line.Add line.

   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
   73
   74
   75
   76
   77
   78
           val portal = Portal("https://www.arcgis.com", Portal.Connection.Anonymous)
   
           val itemId = "41281c51f9de45edaf1c8ed44bb10e30"
           val portalItem = PortalItem(portal, itemId)
           val map = ArcGISMap(portalItem)
   

   Expand

5. Set the map property of mapView to the ArcGISMap you just created.

   MainActivity.kt

   Expand

   Use dark colors for code blocks

   53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 53 54 55 56 57 58 59 60 61 62 63 64 64 64 64 64 64 64 64 64 64 64 64 64 64 64

   Add line.

   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
   73
   74
   75
   76
   77
   78
       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
   
       }
   

   Expand

6. 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:

• Display a scene
• Add a feature layer