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. Tap 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, export, local, offline, package, tiles
Sample Code
// Copyright 2022 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.
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.Tasks.Offline;
using Esri.ArcGISRuntime.UI;
using Colors = System.Drawing.Color;
namespace ArcGIS.Samples.ExportTiles
{
[ArcGIS.Samples.Shared.Attributes.Sample(
name: "Export tiles",
category: "Layers",
description: "Download tiles to a local tile cache file stored on the device.",
instructions: "Pan and zoom into the desired area, making sure the area is within the red boundary. Tap the 'Export tiles' button to start the process. On successful completion you will see a preview of the downloaded tile package.",
tags: new[] { "cache", "download", "export", "local", "offline", "package", "tiles" })]
public partial class ExportTiles : ContentPage
{
// URL to the service tiles will be exported from.
private Uri _serviceUri = new Uri("https://services.arcgisonline.com/arcgis/rest/services/World_Topo_Map/MapServer");
// Path to exported tile cache.
private string _tilePath;
// Flag to indicate whether an exported tile cache is being previewed.
private bool _previewOpen = false;
// Reference to the original basemap.
private Map _basemap;
// Reference to the original viewpoint (when previewing).
private Viewpoint _originalView;
// Holder for the Graphics Overlay (so that it can be hidden and re-added for preview/non-preview state).
private GraphicsOverlay _overlay;
// Hold a reference to the export job for use in event handler.
private ExportTileCacheJob _job;
public ExportTiles()
{
InitializeComponent();
// Call a function to set up the sample.
_ = Initialize();
}
private async Task Initialize()
{
// Create the tile layer.
try
{
ArcGISTiledLayer myLayer = new ArcGISTiledLayer(_serviceUri);
// Load the layer.
await myLayer.LoadAsync();
// Create the basemap with the layer.
_basemap = new Map(new Basemap(myLayer))
{
// Set the min and max scale - export task fails if the scale is too big or small.
MaxScale = 5000000,
MinScale = 10000000
};
// Assign the map to the mapview.
MyMapView.Map = _basemap;
// Create a new symbol for the extent graphic.
// This is the red box that visualizes the extent for which tiles will be exported.
SimpleLineSymbol myExtentSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Colors.Red, 2);
// Create graphics overlay for the extent graphic and apply a renderer.
GraphicsOverlay extentOverlay = new GraphicsOverlay
{
Renderer = new SimpleRenderer(myExtentSymbol)
};
// Add graphics overlay to the map view.
MyMapView.GraphicsOverlays.Add(extentOverlay);
// Subscribe to changes in the mapview's viewpoint so the preview box can be kept in position.
MyMapView.ViewpointChanged += MyMapView_ViewpointChanged;
// Update the graphic - needed in case the user decides not to interact before pressing the button.
UpdateMapExtentGraphic();
// Enable the export button once the sample is ready.
MyExportPreviewButton.IsEnabled = true;
// Set viewpoint of the map.
MyMapView.SetViewpoint(new Viewpoint(-4.853791, 140.983598, _basemap.MinScale));
}
catch (Exception ex)
{
await Application.Current.MainPage.DisplayAlert("Error", ex.Message, "OK");
}
}
private void MyMapView_ViewpointChanged(object sender, EventArgs e)
{
UpdateMapExtentGraphic();
}
/// <summary>
/// Function used to keep the overlaid preview area marker in position
/// This is called by MyMapView_ViewpointChanged every time the user pans/zooms
/// and updates the red box graphic to outline 80% of the current view
/// </summary>
private void UpdateMapExtentGraphic()
{
// Return if mapview is null.
if (MyMapView == null) { return; }
// Get the new viewpoint.
Viewpoint myViewPoint = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);
// Return if viewpoint is null.
if (myViewPoint == null) { return; }
// Get the updated extent for the new viewpoint.
Envelope extent = myViewPoint.TargetGeometry as Envelope;
// Return if extent is null.
if (extent == null) { return; }
// Create an envelope that is a bit smaller than the extent.
EnvelopeBuilder envelopeBldr = new EnvelopeBuilder(extent);
envelopeBldr.Expand(0.80);
// Get the (only) graphics overlay in the map view.
GraphicsOverlay extentOverlay = MyMapView.GraphicsOverlays.FirstOrDefault();
// Return if there is none (in preview, the overlay shouldn't be there).
if (extentOverlay == null) { return; }
// Get the extent graphic.
Graphic extentGraphic = extentOverlay.Graphics.FirstOrDefault();
// Create the extent graphic and add it to the overlay if it doesn't exist.
if (extentGraphic == null)
{
extentGraphic = new Graphic(envelopeBldr.ToGeometry());
extentOverlay.Graphics.Add(extentGraphic);
}
else
{
// Otherwise, update the graphic's geometry.
extentGraphic.Geometry = envelopeBldr.ToGeometry();
}
}
private async Task StartExport()
{
try
{
// Update the tile cache path.
_tilePath = $"{Path.GetTempFileName()}.tpkx";
// Get the parameters for the job.
ExportTileCacheParameters parameters = GetExportParameters();
// Create the task.
ExportTileCacheTask exportTask = await ExportTileCacheTask.CreateAsync(_serviceUri);
// Create the export job.
_job = exportTask.ExportTileCache(parameters, _tilePath);
// Update the UI.
MyProgressBar.Progress = 0.0;
MyProgressBar.IsVisible = true;
MyProgressBarLabel.IsVisible = true;
MyCancelJobButton.IsVisible = true;
MyExportPreviewButton.IsVisible = false;
// Add an event handler to update the progress bar as the task progresses.
_job.ProgressChanged += Job_ProgressChanged;
// Add an event handler to hide the cancel job button if the job completes, fails or is cancelled.
_job.StatusChanged += Job_StatusChanged;
// Start the export job.
_job.Start();
// Get the tile cache result.
TileCache resultTileCache = await _job.GetResultAsync();
// Do the rest of the work.
await HandleJobCompletion(resultTileCache);
}
catch (Exception ex)
{
await Application.Current.MainPage.DisplayAlert("Error", ex.Message, "OK");
}
}
private void UpdateProgressBar(int progress)
{
Microsoft.Maui.ApplicationModel.MainThread.BeginInvokeOnMainThread(() =>
{
// Update the progress bar value.
MyProgressBar.Progress = progress / 100.0;
MyProgressBarLabel.Text = progress == 100 ? "Done" : $"{progress}%";
});
}
private ExportTileCacheParameters GetExportParameters()
{
// Create a new parameters instance.
ExportTileCacheParameters parameters = new ExportTileCacheParameters();
// Get the (only) graphics overlay in the map view.
GraphicsOverlay extentOverlay = MyMapView.GraphicsOverlays.First();
// Get the area selection graphic's extent.
Graphic extentGraphic = extentOverlay.Graphics.First();
// Set the area for the export.
parameters.AreaOfInterest = extentGraphic.Geometry;
// Set the highest possible export quality.
parameters.CompressionQuality = 100;
// Add level IDs 1-9.
// Note: Failing to add at least one Level ID will result in job failure.
for (int x = 1; x < 10; x++)
{
parameters.LevelIds.Add(x);
}
// Return the parameters.
return parameters;
}
private async Task HandleJobCompletion(TileCache cache)
{
// Update the view if the job is complete.
if (_job.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Succeeded)
{
// Show the exported tiles on the preview map.
await UpdatePreviewMap(cache);
// Update the UI.
MyExportPreviewButton.Text = "Return to online map";
MyExportPreviewButton.IsVisible = true;
MyExportPreviewButton.IsEnabled = true;
// Set the preview open flag.
_previewOpen = true;
// Store the overlay for later.
_overlay = MyMapView.GraphicsOverlays.FirstOrDefault();
// Then hide it.
MyMapView.GraphicsOverlays.Clear();
}
else if (_job.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Failed)
{
// Notify the user.
await Application.Current.MainPage.DisplayAlert("Error", "Job Failed", "OK");
// Update the UI.
MyExportPreviewButton.Text = "Export Tiles";
MyExportPreviewButton.IsVisible = true;
MyExportPreviewButton.IsEnabled = true;
// Set the preview open flag.
_previewOpen = false;
}
// Remove the event handlers.
_job.ProgressChanged -= Job_ProgressChanged;
_job.StatusChanged -= Job_StatusChanged;
}
private async Task UpdatePreviewMap(TileCache cache)
{
// Load the cache.
await cache.LoadAsync();
// Create a tile layer with the cache.
ArcGISTiledLayer myLayer = new ArcGISTiledLayer(cache);
// Show the layer in a new map.
MyMapView.Map = new Map(new Basemap(myLayer));
}
private async Task ExportPreviewTask()
{
// If preview isn't open, start an export.
try
{
if (!_previewOpen)
{
// Disable the export button.
MyExportPreviewButton.IsEnabled = false;
// Save the map viewpoint.
_originalView = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);
// Start the export.
await StartExport();
}
else // Otherwise, close the preview.
{
// Update the UI.
MyExportPreviewButton.Text = "Export Tiles";
MyProgressBar.IsVisible = false;
MyProgressBarLabel.IsVisible = false;
// Clear the preview open flag.
_previewOpen = false;
// Re-apply the original map.
MyMapView.Map = _basemap;
// Re-apply the original viewpoint.
MyMapView.SetViewpoint(_originalView);
// Re-show the overlay.
MyMapView.GraphicsOverlays.Add(_overlay);
// Update the graphic.
UpdateMapExtentGraphic();
}
}
catch (Exception ex)
{
await Application.Current.MainPage.DisplayAlert("Error", ex.Message, "OK");
}
}
private void MyExportPreviewButton_Clicked(object sender, EventArgs e)
{
_ = ExportPreviewTask();
}
private void MyCancelJobButton_Clicked(object sender, EventArgs e)
{
if (_job != null)
{
_ = _job.CancelAsync();
// Remove the event handlers.
_job.ProgressChanged -= Job_ProgressChanged;
_job.StatusChanged -= Job_StatusChanged;
// Update the UI.
MyCancelJobButton.IsVisible = false;
MyProgressBar.IsVisible = false;
MyProgressBarLabel.IsVisible = false;
MyExportPreviewButton.IsVisible = true;
MyExportPreviewButton.IsEnabled = true;
}
}
private void Job_ProgressChanged(object sender, EventArgs e)
{
Microsoft.Maui.ApplicationModel.MainThread.BeginInvokeOnMainThread(() =>
{
// Update the progress bar value.
MyProgressBar.Progress = _job.Progress / 100.0;
MyProgressBarLabel.Text = _job.Progress == 100 ? "Done" : $"{_job.Progress}%";
});
}
private void Job_StatusChanged(object sender, Esri.ArcGISRuntime.Tasks.JobStatus e)
{
Microsoft.Maui.ApplicationModel.MainThread.BeginInvokeOnMainThread(() =>
{
MyCancelJobButton.IsVisible = (_job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Failed &&
_job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Succeeded &&
_job.Status != Esri.ArcGISRuntime.Tasks.JobStatus.Canceling);
});
}
}
}