Export Tiles

Demonstrates how to export tiles from a tiled layer.

How it works

To export tiles from an ArcGISTiledLayer:

  1. Create an ExportTileCacheTask, passing in the URI of the tiled layer
  2. Create default ExportTileCacheParameters with task.createDefaultExportTileCacheParametersAsync (extent, minScale, maxScale)
  3. Call task.exportTileCacheAsync(defaultParams, downloadFile) to create the ExportTileCacheJob
  4. Call job.start() to start the job
  5. When the job is done, use job.getResult() to get the resulting TileCache


 * Copyright 2017 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.tiledlayers.export_tiles;

import java.io.File;
import java.io.IOException;
import java.util.concurrent.ExecutionException;

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.stage.Stage;

import com.esri.arcgisruntime.concurrent.Job;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.data.TileCache;
import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.layers.ArcGISTiledLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
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.symbology.SimpleLineSymbol;
import com.esri.arcgisruntime.tasks.tilecache.ExportTileCacheJob;
import com.esri.arcgisruntime.tasks.tilecache.ExportTileCacheParameters;
import com.esri.arcgisruntime.tasks.tilecache.ExportTileCacheTask;

public class ExportTilesSample extends Application {

  private MapView mapView;

  public void start(Stage stage) throws Exception {

    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("Export Tiles Sample");

      // create an ArcGISTiledLayer to use as the basemap
      ArcGISTiledLayer tiledLayer = new ArcGISTiledLayer("https://sampleserver6.arcgisonline" +
      ArcGISMap map = new ArcGISMap(new Basemap(tiledLayer));

      // set the map to the map view
      mapView = new MapView();

      // create a graphics overlay for the map view
      GraphicsOverlay graphicsOverlay = new GraphicsOverlay();

      // create a graphic to show a box around the tiles we want to download
      Graphic downloadArea = new Graphic();
      SimpleLineSymbol simpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, 0xFFFF0000, 2);

      // update the box whenever the viewpoint changes
      mapView.addViewpointChangedListener(viewpointChangedEvent -> {
        if (map.getLoadStatus() == LoadStatus.LOADED) {
          // upper left corner of the downloaded tile cache area
          Point2D minScreenPoint = new Point2D(50, 50);
          // lower right corner of the downloaded tile cache 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);

      // create button to export tiles
      Button exportTilesButton = new Button("Export Tiles");

      // create progress bar to show task progress
      ProgressBar progressBar = new ProgressBar();

      // when the button is clicked, export the tiles to a temporary file
      exportTilesButton.setOnAction(e -> {
        try {
          File tempFile = File.createTempFile("tiles", ".tpk");
          double minScale = mapView.getMapScale();
          double maxScale = tiledLayer.getMaxScale();
          // minScale must always be larger than maxScale
          if (minScale <= maxScale) {
            minScale = maxScale + 1;
          ExportTileCacheTask task = new ExportTileCacheTask(tiledLayer.getUri());
          ListenableFuture<ExportTileCacheParameters> createParams = task.createDefaultExportTileCacheParametersAsync
              (downloadArea.getGeometry(), minScale, maxScale);
          createParams.addDoneListener(() -> {
            try {
              ExportTileCacheParameters params = createParams.get();
              ExportTileCacheJob job = task.exportTileCacheAsync(params, tempFile.getAbsolutePath());
              job.addProgressChangedListener(() -> progressBar.setProgress(job.getProgress() / 100.0));
              job.addJobDoneListener(() -> {
                if (job.getStatus() == Job.Status.SUCCEEDED) {
                  //show preview of exported tiles in alert
                  TileCache tileCache = job.getResult();
                  Alert preview = new Alert(Alert.AlertType.INFORMATION);
                  preview.setHeaderText("Exported to " + tileCache.getPath());
                  MapView mapPreview = new MapView();
                  mapPreview.setMinSize(400, 400);
                  ArcGISTiledLayer tiledLayerPreview = new ArcGISTiledLayer(tileCache);
                  ArcGISMap previewMap = new ArcGISMap(new Basemap(tiledLayerPreview));
                } else {
                  Alert alert = new Alert(Alert.AlertType.ERROR, job.getError().getAdditionalMessage());
                Platform.runLater(() -> progressBar.setVisible(false));
            } catch (InterruptedException | ExecutionException ex) {
              Alert alert = new Alert(Alert.AlertType.ERROR, ex.getMessage());
        } catch (IOException ex) {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Failed to create temporary file");

      // add the map view, button, and progress bar to stack pane
      stackPane.getChildren().addAll(mapView, exportTilesButton, progressBar);
      StackPane.setAlignment(exportTilesButton, Pos.TOP_LEFT);
      StackPane.setAlignment(progressBar, Pos.TOP_RIGHT);
    } catch (Exception e) {
      // on any error, display the stack trace.

   * Stops and releases all resources used in application.
  public void stop() throws Exception {

    if (mapView != null) {

   * Opens and runs application.
   * @param args arguments passed to this application
  public static void main(String[] args) {



In this topic
  1. How it works
  2. Code