Skip to content

Generate offline map

View on GitHubSample viewer app

Take a web map offline.

Image of generate offline map

Use case

Taking a web map offline allows users continued productivity when their network connectivity is poor or nonexistent. For example, by taking a map offline, a field worker inspecting utility lines in remote areas could still access a feature's location and attribute information.

How to use the sample

Once the map loads, zoom to the extent you want to take offline. The red border shows the extent that will be downloaded. Click the "Take Map Offline" button to start the offline map job. The progress bar will show the job's progress. When complete, the offline map will replace the online map in the map view.

How it works

  1. Create an ArcGISMap with a Portal item pointing to the web map.
  2. Create GenerateOfflineMapParameters specifying the download area geometry, minimum scale, and maximum scale.
  3. Create an OfflineMapTask with the map.
  4. Create the OfflineMapJob with offlineMapTask.generateOfflineMap(params, downloadDirectoryPath) and start it with offlineMapJob.start().
  5. When the job is done, get the offline map with offlineMapJob.getResult().getOfflineMap().

Relevant API

  • GenerateOfflineMapJob
  • GenerateOfflineMapParameters
  • GenerateOfflineMapResult
  • OfflineMapTask
  • Portal

About the data

The map used in this sample shows the stormwater network within Naperville, IL, USA, with cartography designed for web and mobile devices with offline support.

Additional information

The creation of the offline map can be fine-tuned using parameter overrides for feature layers, or by using local basemaps to achieve more customised results.

Tags

download, offline, save, web map

Sample Code

GenerateOfflineMapSample.java
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 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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 /*  * Copyright 2018 Esri.  *  * Licensed under the Apache License, Version 2.0 (the "License"); you may not  * use this file except in compliance with the License. You may obtain a copy of  * the License at  *  * http://www.apache.org/licenses/LICENSE-2.0  *  * Unless required by applicable law or agreed to in writing, software  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the  * License for the specific language governing permissions and limitations under  * the License.  */  package com.esri.samples.generate_offline_map;  import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path;  import com.esri.arcgisruntime.ArcGISRuntimeEnvironment; import com.esri.arcgisruntime.concurrent.Job; import com.esri.arcgisruntime.geometry.Envelope; import com.esri.arcgisruntime.geometry.Point; import com.esri.arcgisruntime.loadable.LoadStatus; import com.esri.arcgisruntime.mapping.ArcGISMap; import com.esri.arcgisruntime.mapping.view.Graphic; import com.esri.arcgisruntime.mapping.view.GraphicsOverlay; import com.esri.arcgisruntime.mapping.view.MapView; import com.esri.arcgisruntime.portal.Portal; import com.esri.arcgisruntime.portal.PortalItem; import com.esri.arcgisruntime.symbology.SimpleLineSymbol; import com.esri.arcgisruntime.tasks.offlinemap.GenerateOfflineMapJob; import com.esri.arcgisruntime.tasks.offlinemap.GenerateOfflineMapParameters; import com.esri.arcgisruntime.tasks.offlinemap.GenerateOfflineMapResult; import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapTask; import javafx.application.Application; import javafx.application.Platform; import javafx.geometry.Point2D; import javafx.geometry.Pos; import javafx.scene.Scene; import javafx.scene.control.Alert; import javafx.scene.control.Button; import javafx.scene.control.ProgressBar; import javafx.scene.layout.StackPane; import javafx.scene.paint.Color; import javafx.stage.Stage;  public class GenerateOfflineMapSample extends Application {   private ArcGISMap map; // keep loadable in scope to avoid garbage collection  private MapView mapView;   @Override  public void start(Stage stage) {   try {  // create stack pane and application scene  StackPane stackPane = new StackPane();  Scene scene = new Scene(stackPane);   // set title, size, and add scene to stage  stage.setTitle("Generate Offline Map Sample");  stage.setWidth(800);  stage.setHeight(700);  stage.setScene(scene);  stage.show();   // authentication with an API key or named user is required to access basemaps and other location services  String yourAPIKey = System.getProperty("apiKey");  ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);   // create a button to take the map offline  Button offlineMapButton = new Button("Take Map Offline");  offlineMapButton.setDisable(true);   // create a portal item with the itemId of the web map  var portal = new Portal("https://www.arcgis.com");  var portalItem = new PortalItem(portal, "acc027394bc84c2fb04d1ed317aac674");   // create a map with the portal item  map = new ArcGISMap(portalItem);  map.addDoneLoadingListener(() -> {  // enable the button when the map is loaded  if (map.getLoadStatus() == LoadStatus.LOADED) {  offlineMapButton.setDisable(false);  }  });   // set the map to the map view  mapView = new MapView();  mapView.setMap(map);   // create a graphics overlay for the map view  var graphicsOverlay = new GraphicsOverlay();  mapView.getGraphicsOverlays().add(graphicsOverlay);   // create a graphic to show a box around the extent we want to download  Graphic downloadArea = new Graphic();  graphicsOverlay.getGraphics().add(downloadArea);  SimpleLineSymbol simpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.RED, 2);  downloadArea.setSymbol(simpleLineSymbol);   // update the box whenever the viewpoint changes  mapView.addViewpointChangedListener(viewpointChangedEvent -> {  if (map.getLoadStatus() == LoadStatus.LOADED) {  // upper left corner of the area to take offline  Point2D minScreenPoint = new Point2D(50, 50);  // lower right corner of the downloaded area  Point2D maxScreenPoint = new Point2D(mapView.getWidth() - 50, mapView.getHeight() - 50);  // convert screen points to map points  Point minPoint = mapView.screenToLocation(minScreenPoint);  Point maxPoint = mapView.screenToLocation(maxScreenPoint);  // use the points to define and return an envelope  if (minPoint != null && maxPoint != null) {  Envelope envelope = new Envelope(minPoint, maxPoint);  downloadArea.setGeometry(envelope);  }  }  });   // create progress bar to show download progress  var progressBar = new ProgressBar(0.0);  progressBar.setVisible(false);   // when the button is clicked, start the offline map task job  offlineMapButton.setOnAction(e -> {  try {  // show the progress bar  progressBar.setVisible(true);   // specify the extent, min scale, and max scale as parameters  double minScale = mapView.getMapScale();  double maxScale = map.getMaxScale();  // minScale must always be larger than maxScale  if (minScale <= maxScale) {  minScale = maxScale + 1;  }  GenerateOfflineMapParameters params = new GenerateOfflineMapParameters(downloadArea.getGeometry(), minScale, maxScale);   // create an offline map task with the map  OfflineMapTask task = new OfflineMapTask(map);   // create an offline map job with the download directory path and parameters and start the job  Path tempDirectory = Files.createTempDirectory("offline_map");  GenerateOfflineMapJob job = task.generateOfflineMap(params, tempDirectory.toAbsolutePath().toString());  job.start();  job.addJobDoneListener(() -> {  if (job.getStatus() == Job.Status.SUCCEEDED) {  // replace the current map with the result offline map when the job finishes  GenerateOfflineMapResult result = job.getResult();  mapView.setMap(result.getOfflineMap());  graphicsOverlay.getGraphics().clear();  offlineMapButton.setDisable(true);  } else {  new Alert(Alert.AlertType.ERROR, job.getError().getMessage()).show();  }  Platform.runLater(() -> progressBar.setVisible(false));  });  // show the job's progress with the progress bar  job.addProgressChangedListener(() -> progressBar.setProgress(job.getProgress() / 100.0));  } catch (IOException ex) {  new Alert(Alert.AlertType.ERROR, "Failed to create temporary directory").show();  }  });   // add the map view, button, and progress bar to stack pane  stackPane.getChildren().addAll(mapView, offlineMapButton, progressBar);  StackPane.setAlignment(offlineMapButton, Pos.TOP_LEFT);  StackPane.setAlignment(progressBar, Pos.TOP_RIGHT);  } catch (Exception e) {  // on any error, display the stack trace.  e.printStackTrace();  }  }   /**  * Stops and releases all resources used in the application.  */  @Override  public void stop() {   if (mapView != null) {  mapView.dispose();  }  }   /**  * Opens and runs application.  *  * @param args arguments passed to this application  */  public static void main(String[] args) {   Application.launch(args);  }  }

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.