Download tiles to a local tile cache file stored on the device.
Use case
Field workers with limited network connectivity can use exported tiles as a basemap for use offline.
How to use the sample
Pan and zoom into the desired area, making sure the area is within the red boundary. Click the 'Export tiles' button to start the process. On successful completion you will see a preview of the downloaded tile package.
How it works
- Create a map and set its
minScaleto 10,000,000. Limiting the scale in this sample limits the potential size of the selection area, thereby keeping the exported tile package to a reasonable size. - Create an
ExportTileCacheTask, passing in the URI of the tiled layer. - Create default
ExportTileCacheParametersfor the task, specifying extent, minimum scale and maximum scale. - Use the parameters and a path to create an
ExportTileCacheJobfrom the task. - Start the job, and when it completes successfully, get the resulting
TileCache. - Use the tile cache to create an
ArcGISTiledLayer, and display it in the map.
Relevant API
- ArcGISTiledLayer
- ExportTileCacheJob
- ExportTileCacheParameters
- ExportTileCacheTask
- TileCache
Additional information
ArcGIS tiled layers do not support reprojection, query, select, identify, or editing. See the Layer types discussion in the developers guide to learn more about the characteristics of ArcGIS tiled layers.
Tags
cache, download, offline
Sample Code
MainActivity.kt
/*
* Copyright 2020 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.arcgisruntime.sample.exporttiles
import android.graphics.Color
import android.os.Bundle
import android.util.Log
import android.view.View
import android.widget.Button
import android.widget.TextView
import android.widget.Toast
import androidx.appcompat.app.AlertDialog
import androidx.appcompat.app.AppCompatActivity
import androidx.constraintlayout.widget.ConstraintLayout
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment
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.BasemapStyle
import com.esri.arcgisruntime.mapping.Viewpoint
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.sample.exporttiles.databinding.ActivityMainBinding
import com.esri.arcgisruntime.sample.exporttiles.databinding.ExportTilesDialogLayoutBinding
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
import java.io.File
class MainActivity : AppCompatActivity() {
private val TAG: String = MainActivity::class.java.simpleName
private var exportTileCacheJob: ExportTileCacheJob? = null
private var downloadArea: Graphic? = null
private val activityMainBinding by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
private val exportTilesButton: Button by lazy {
activityMainBinding.exportTilesButton
}
private val mapPreviewLayout: ConstraintLayout by lazy {
activityMainBinding.mapPreviewLayout
}
private val previewTextView: TextView by lazy {
activityMainBinding.previewTextView
}
private val mapView: MapView by lazy {
activityMainBinding.mapView
}
private val closeButton: Button by lazy {
activityMainBinding.closeButton
}
private val previewMapView: MapView by lazy {
activityMainBinding.previewMapView
}
private val dimBackground: View by lazy {
activityMainBinding.dimBackground
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(activityMainBinding.root)
// authentication with an API key or named user is required
// to access basemaps and other location services
ArcGISRuntimeEnvironment.setApiKey(BuildConfig.API_KEY)
// create an ArcGISTiledLayer to use as the basemap
val map = ArcGISMap().apply {
basemap = Basemap(BasemapStyle.ARCGIS_IMAGERY)
minScale = 10000000.0
}
// create a graphic and graphics overlay to show a red box around the tiles to be downloaded
downloadArea = Graphic()
downloadArea?.symbol = SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.RED, 2f)
val graphicsOverlay = GraphicsOverlay()
graphicsOverlay.graphics.add(downloadArea)
// set the map to the map view
mapView.map = map
mapView.setViewpoint(Viewpoint(35.0, -117.0, 10000000.0))
// add the graphics overlay to the map view
mapView.graphicsOverlays.add(graphicsOverlay)
mapView.addViewpointChangedListener {
updateDownloadAreaGeometry()
}
map.addDoneLoadingListener {
val tiledLayer: ArcGISTiledLayer = map.basemap.baseLayers[0] as ArcGISTiledLayer
// when the button is clicked, export the tiles to the temporary directory
exportTilesButton.setOnClickListener {
updateDownloadAreaGeometry()
val exportTileCacheTask = ExportTileCacheTask(tiledLayer.uri)
// set up the export tile cache parameters
val parametersFuture: ListenableFuture<ExportTileCacheParameters> =
exportTileCacheTask.createDefaultExportTileCacheParametersAsync(
downloadArea?.geometry,
mapView.mapScale,
mapView.mapScale * 0.1
)
parametersFuture.addDoneListener {
try {
val parameters: ExportTileCacheParameters = parametersFuture.get()
// create a temporary directory in the app's cache for saving exported tiles
val exportTilesDirectory =
File(externalCacheDir, getString(R.string.tile_cache_folder))
// export tiles to temporary cache on device
exportTileCacheJob =
exportTileCacheTask.exportTileCache(
parameters,
exportTilesDirectory.path + "file.tpkx"
).apply {
// start the export tile cache job
start()
val dialogLayoutBinding =
ExportTilesDialogLayoutBinding.inflate(layoutInflater)
// show progress of the export tile cache job on the progress bar
val dialog = createProgressDialog(this)
dialog.setView(dialogLayoutBinding.root)
dialog.show()
// on progress change
addProgressChangedListener {
dialogLayoutBinding.progressBar.progress = progress
dialogLayoutBinding.progressTextView.text = "$progress%"
}
// when the job has completed, close the dialog and show the job result in the map preview
addJobDoneListener {
dialog.dismiss()
if (status == Job.Status.SUCCEEDED) {
showMapPreview(result)
downloadArea?.isVisible = false
} else {
("Job did not succeed: " + error.additionalMessage).also {
Toast.makeText(this@MainActivity, it, Toast.LENGTH_LONG)
.show()
Log.e(TAG, error.additionalMessage)
}
}
}
}
} catch (e: Exception) {
val error = "Error generating tile cache parameters: ${e.message}"
Toast.makeText(this, error, Toast.LENGTH_LONG).show()
Log.e(TAG, error)
}
}
}
}
// get correct view order set up on start
clearPreview(mapView)
}
/**
* Updates the [downloadArea]'s geometry on ViewPoint change
* or when export tiles is clicked.
*/
private fun updateDownloadAreaGeometry() {
try {
mapView.apply {
if (mapView.map.loadStatus == LoadStatus.LOADED) {
// upper left corner of the downloaded tile cache area
val minScreenPoint: android.graphics.Point = android.graphics.Point(150, 175)
// lower right corner of the downloaded tile cache area
val maxScreenPoint: android.graphics.Point = android.graphics.Point(
mapView.width - 150,
mapView.height - 250
)
// convert screen points to map points
val minPoint: Point = mapView.screenToLocation(minScreenPoint)
val maxPoint: Point = mapView.screenToLocation(maxScreenPoint)
// use the points to define and return an envelope
downloadArea?.geometry = Envelope(minPoint, maxPoint)
}
}
} catch (e: java.lang.Exception) {
// Silently fail, since mapView has not been rendered yet.
}
}
/**
* Show tile cache preview window including containing the exported tiles.
*
* @param result takes the TileCache from the ExportTileCacheJob
*/
private fun showMapPreview(result: TileCache) {
// set up the preview map view
previewMapView.apply {
map = ArcGISMap(Basemap(ArcGISTiledLayer(result)))
setViewpoint(mapView.getCurrentViewpoint(Viewpoint.Type.CENTER_AND_SCALE))
}
// control UI visibility
previewMapView.getChildAt(0).visibility = View.VISIBLE
show(closeButton, dimBackground, previewTextView, previewMapView)
exportTilesButton.visibility = View.GONE
// required for some Android devices running older OS (combats Z-ordering bug in Android API)
mapPreviewLayout.bringToFront()
}
/**
* Clear the preview window.
*/
fun clearPreview(view: View) {
previewMapView.getChildAt(0).visibility = View.INVISIBLE
hide(closeButton, dimBackground, previewTextView, previewMapView)
// control UI visibility
show(exportTilesButton, mapView)
downloadArea?.isVisible = true
// required for some Android devices running older OS (combats Z-ordering bug in Android API)
mapView.bringToFront()
}
/**
* Create a progress dialog box for tracking the export tile cache job.
*
* @param exportTileCacheJob the export tile cache job progress to be tracked
* @return an AlertDialog set with the dialog layout view
*/
private fun createProgressDialog(exportTileCacheJob: ExportTileCacheJob): AlertDialog {
val builder = AlertDialog.Builder(this@MainActivity).apply {
setTitle("Exporting tiles...")
// provide a cancel button on the dialog
setNeutralButton("Cancel") { _, _ ->
exportTileCacheJob.cancelAsync()
}
setCancelable(false)
val dialogLayoutBinding = ExportTilesDialogLayoutBinding.inflate(layoutInflater)
setView(dialogLayoutBinding.root)
}
return builder.create()
}
/**
* Makes the given views in the UI visible.
*
* @param views the views to be made visible
*/
private fun show(vararg views: View) {
for (view in views) {
view.visibility = View.VISIBLE
}
}
/**
* Makes the given views in the UI visible.
*
* @param views the views to be made visible
*/
private fun hide(vararg views: View) {
for (view in views) {
view.visibility = View.INVISIBLE
}
}
override fun onResume() {
super.onResume()
mapView.resume()
previewMapView.resume()
}
override fun onPause() {
mapView.pause()
previewMapView.pause()
super.onPause()
}
override fun onDestroy() {
mapView.dispose()
super.onDestroy()
}
}