Display a map from a mobile map package

Learn how to display a map from a mobile map package (.mmpk file) when you're offline.

In this tutorial you use the MobileMapPackage class to access the .mmpk file, MahouRivieraTrails.mmpk, and load it to read its contents. The map within the mobile map package contains a basemap layer and data layers and does not require a network connection.

Prerequisites

Steps

Open a Java project

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

2. Open the build.gradle file as a project in IntelliJ IDEA.

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 IntelliJ IDEA's Project tool window, open src/main/java/com.example.app and double-click App.

   3. In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your API key. Replace YOUR_API_KEY with your actual API Key. Be sure to surround your API Key with quotes, because the parameter passed to setApiKey is a string.

      App.java

      Use dark colors for code blocks

                                                                                     

      Change 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
      79
        @Override
        public void start(Stage stage) {
          // set the title and size of the stage and show it
          stage.setTitle("Display a map tutorial");
          stage.setWidth(800);
          stage.setHeight(700);
          stage.show();
      
          // create a JavaFX scene with a stack pane as the root node, and add it to the scene
          StackPane stackPane = new StackPane();
          Scene scene = new Scene(stackPane);
          stage.setScene(scene);
      
          // Note: it is not best practice to store API keys in source code.
          // The API key is referenced here for the convenience of this tutorial.
          String yourApiKey = "YOUR_API_KEY";
          ArcGISRuntimeEnvironment.setApiKey(yourApiKey);
      

Prepare files before coding the app

Modify the files from the Display a map tutorial so they can be used in this tutorial: you will replace imports, change the application title, and remove unnecessary code.

1. In IntelliJ IDEA's Project tool window, open src/main/java/com.example.app and double-click App. Add the following imports, replacing those from the Display a map tutorial:

   App.java

   Expand

   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
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   package com.example.app;
   
   import java.io.File;
   
   import com.esri.arcgisruntime.loadable.LoadStatus;
   import com.esri.arcgisruntime.mapping.MobileMapPackage;
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   import com.esri.arcgisruntime.mapping.view.MapView;
   
   import javafx.scene.control.Alert;
   import javafx.application.Application;
   import javafx.scene.Scene;
   import javafx.scene.layout.StackPane;
   import javafx.stage.Stage;
   
   
   public class App extends Application {
   

   Expand

2. In the start() life-cycle method, change the title that will appear on the application window to Display a map from a mobile map package.

   App.java

   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
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
       @Override
       public void start(Stage stage) {
   
           try {
   
               // create the stack pane and JavaFX application scene
               StackPane stackPane = new StackPane();
               Scene scene = new Scene(stackPane);
   
               // set title, size, and add scene to stage
   
               stage.setTitle("Display a map from a mobile map package");
   
               stage.setWidth(800);
               stage.setHeight(700);
               stage.setScene(scene);
               stage.show();
   

3. Delete the map, setting the map on the map view, and the map's initial viewpoint. The mobile map package will be used in place of this code later on in the tutorial.

   App.java

   Use dark colors for code blocks

                                                                                  

   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
       // create a map view to display the map and add it to the stack pane
       mapView = new MapView();
       stackPane.getChildren().add(mapView);
   
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   
       // set the map on the map view
       mapView.setMap(map);
   
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   

Add a mobile map package to the project

Add a mobile map package (.mmpk) for distribution with your app.

1. Create or download the MahouRivieraTrails.mmpk mobile map package. Complete the Create a mobile map package tutorial to create the package yourself. Otherwise, download the solution file: MahouRiveraTrails.mmpk.

2. Copy MahouRivieraTrails.mmpk in the system file manager and paste it to the project's root directory in IntelliJ IDEA's Project tool window. See IntelliJ IDEA's documentation for additional methods of importing files for alternative approaches (Import files), if necessary.

Create a mobile map package

Create a MobileMapPackage and assign it to the mobileMapPackage member variable. Also surround your code with a Java try statement, which will be later followed by a catch that prints a standard stack trace.

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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
public class App extends Application {

    private MapView mapView;

    private MobileMapPackage mobileMapPackage;


    @Override
    public void start(Stage stage) {

        try {

            // create the stack pane and JavaFX application scene
            StackPane stackPane = new StackPane();
            Scene scene = new Scene(stackPane);

            // set title, size, and add scene to stage

            stage.setTitle("Display a map from a mobile map package");

            stage.setWidth(800);
            stage.setHeight(700);
            stage.setScene(scene);
            stage.show();

            // Note: it is not best practice to store API keys in source code.
            // The API key is referenced here for the convenience of this tutorial.
            String yourApiKey = "YOUR_API_KEY";
            ArcGISRuntimeEnvironment.setApiKey(yourApiKey);

            // create a map view
            mapView = new MapView();

            //Set the location of the .mmpk file to the project root folder
            final String mmpkPath = new File(System.getProperty("user.dir"), "./MahouRivieraTrails.mmpk").getAbsolutePath();
            mobileMapPackage = new MobileMapPackage(mmpkPath);

Load the mobile map package file and display its map

1. The following code shows how to load the mobile map package (.mmpk) file to get a list of its maps and then select the map you want to display. It also adds the try statement's closing catch statement.

   App.java

   Expand

   Use dark colors for code blocks

                                                                                                        

   Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.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
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
               //Set the location of the .mmpk file to the project root folder
               final String mmpkPath = new File(System.getProperty("user.dir"), "./MahouRivieraTrails.mmpk").getAbsolutePath();
               mobileMapPackage = new MobileMapPackage(mmpkPath);
   
               mobileMapPackage.loadAsync();
               mobileMapPackage.addDoneLoadingListener(() -> {
                   if (mobileMapPackage.getLoadStatus() == LoadStatus.LOADED && mobileMapPackage.getMaps().size() > 0) {
                       //add the map from the mobile map package to the map view
                       mapView.setMap(mobileMapPackage.getMaps().get(0));
                   } else {
                       Alert alert = new Alert(Alert.AlertType.ERROR, "Failed to load the mobile map package");
                       alert.show();
                   }
               });
   
               // add the map view to stack pane
               stackPane.getChildren().add(mapView);
   
           } catch (Exception e) {
               // on any error, display the stack trace
               e.printStackTrace();
           }
   
       }
   

   Expand

2. Run the app. Ensure to run the app as a Gradle task and not as an application in your IDE. In the Gradle tool window, under Tasks > application, double-click run.

You should see a map of trail heads, trails, and parks for the area south of the Santa Monica mountains. You can zoom, rotate, drag, and double-tap the map view to explore the map.