Offline maps

What is an offline map?

An offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more is a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more downloaded from a web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more. It also includes data content that is referenced by layers in the offline map. You can use an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more in your partially offline appA partially offline app is a type of offline app built with ArcGIS Maps SDKs for Native Apps that is designed to work where network connectivity is unreliable.Learn more to edit featuresA feature is a single record, also known as a row, that represents a real-world entity. It typically contains a geometry (point, multipoint, polyline, or polygon) and attributes but it can also contain just attributes.Learn more, non-spatial data, related records, and attachments without a network connection. You keep an offline map's data content current with the content of the source web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more's layers by synchronizing the offline map and the web map. A network connection is required to synchronize.

You use offline mapsAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more to create offline appsAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more that:

• Provide detailed, editable, interactive maps to large mobile workforces.
• View, collect and edit data in remote areas where network connectivity is unpredictable or unavailable.
• Support disaster recovery operations when infrastructure has been damaged.
• Keep map data up to date with the latest edits from mobile workers.
• Keep mobile workers updated with the latest data and maps.

How to work with offline maps

The general workflow to work with an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more in an offline applicationAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more is:

1. Create

To begin working with an offline map, create a web map and enable it for offline use. To create a new web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more, you can use Map ViewerMap Viewer is a browser-based mapping tool that can view, create, and save web maps. It can also perform mapping, visualization, and spatial analysis operations.Learn more or ArcGIS ProArcGIS Pro is a professional desktop GIS application that can explore, visualize, analyze, and manage 2D and 3D data.Learn more. These tools allow you to design and configure a map interactively and then save it in a portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more.

Once your web map is saved, go to the item pageAn item page is a web page in ArcGIS Online or the developer dashboard used to access and manage the properties for an item and the content it references such as a web map, hosted layer, or file.Learn more of the web map in ArcGIS OnlineArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account.Learn more to enable it for offline use. Make sure that all the layers included in the web map are also offline-enabled. Layers that reference the following servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more can have their data content included in the offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more:

• The basemap styles serviceThe ArcGIS Basemap Styles service, also referred to as the Basemap Styles service, is a location service that provides basemap styles and data for the world. It returns styles as Mapbox styles and web maps, and data as vector tiles and/or map tiles. It supports all of the styles in the ArcGIS Basemap style and Open Basemap style family. An ArcGIS Location Platform or ArcGIS Online account is required to use the service.Learn more (including default basemap styles and custom basemap styles created using the Vector Tile Style EditorThe ArcGIS Vector Tile Style Editor is a web-based application used to create, edit, and save a custom style for vector tile basemap layer.Learn more).
• A feature serviceA feature service is a data service that provides access to spatial and non-spatial data in feature layers, feature layer views, and tables.Learn more that has been offline enabledOffline-enabled is a setting in a web map or hosted layer item that allows it to be downloaded and used by offline apps.Learn more. This includes features, non-spatial data, related records, and attachments.
• A vector tile serviceA vector tile service is a data service that provides access to vector tile data and a style definition.Learn more that has been offline enabledOffline-enabled is a setting in a web map or hosted layer item that allows it to be downloaded and used by offline apps.Learn more.
• A map tile serviceA map tile service, formerly known as image tile service, is a data service that provides access to static, pre-rendered mao tiles. The tiles are typical in PNG format. Map tiles are typically retrieved by specifying a specific level, row, and column value.Learn more that has been offline enabledOffline-enabled is a setting in a web map or hosted layer item that allows it to be downloaded and used by offline apps.Learn more.

Other layersA layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services.Learn more can be included in an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more but continue to reference the online data source. These layers can be used whenever the offline appAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more has a network connection. In addition to data layers, an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more can include tables of non-spatial data. A non-spatial table typically contains rows of data related to features in the source web map's data layers.

2. Manage

After configuring a web map and enabling it for offline use, there are two ways to manage and define map areas inside the web map to take offline.

Define the map areas ahead-of-time

In this method, the owner of the web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more must first define geographic areas of the web map to be packaged as offline mapsAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more. These geographic areas are known as offline map areasAn offline map area, also known as a preplanned map area, is an area in a web map used to create an offline map.Learn more or preplanned map areas, since they are planned and defined beforehand. If you choose this method, you will have to define your offline map areas in the web map's item page in the portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more using the Manage offline map areas button. A web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more can have up to 16 offline map areas defined. You can also configure settings such as packaging schedule of your offline map area and level of detail for the downloaded raster or vector tile layer. Offline map areas remain available for download until the owner of the web map removes the offline map area from the web map. They can also be downloaded multiple times by different offline applicationsAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more.

Offline map areas are quick to download and ready to be used because they are generated before they are needed. They are hosted alongside the web map, ready for download, so the user experience is similar to downloading any other file or resource. These maps also support updating packages, which can be useful for applications that cover large areas, are updated frequently, or support many mobile workers.

Define the map areas on-demand

In this method, the user of the offline appAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more requests for an area of the web mapA web map is a map stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web map specification.Learn more to be packaged as an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more. Then, the ArcGIS Maps SDK for Native AppsArcGIS Maps SDKs for Native Apps, previously known as ArcGIS Runtime SDKs, are developer products for building mapping and spatial analysis applications for native devices.Learn more generates the specified area and downloads it. This process happens on demand, hence the name. If you choose this method, you will define an area in your application code (generally using the Polygon class from ArcGIS Maps SDKs for Native AppsArcGIS Maps SDKs for Native Apps, previously known as ArcGIS Runtime SDKs, are developer products for building mapping and spatial analysis applications for native devices.Learn more) that represents an area within the web map you want to download as an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more. The offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more can only be downloaded once by the offline applicationAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more that requested it. It is not hosted for later download. If another offline application needs to download the same map area, it must make a new request.

While this method gives the app users more flexibility to choose their own desired map area to download, each offline map must be generated at the time it is requested. This introduces a delay before the offline map can be downloaded, which impacts the offline application's user experience. To mitigate this delay, there are ways you can optimize downloading your on-demand offline maps.

3. Access

After you create an offline-enabled web map and manage the offline map, you can download and display the offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more with an offline appAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more built with ArcGIS Maps SDKs for Native AppsArcGIS Maps SDKs for Native Apps, previously known as ArcGIS Runtime SDKs, are developer products for building mapping and spatial analysis applications for native devices.Learn more. The code will differ based on whether you use the ahead-of-time or on-demand method to download the offline map.

There are two steps to access an offline map:

1. When you download and display it for the first time. This requires a network connection.
   ArcGIS Maps SDK for .NETArcGIS Maps SDK for .NETArcGIS Maps SDK for KotlinArcGIS Maps SDK for SwiftArcGIS Maps SDK for JavaArcGIS Maps SDK for QtArcGIS Maps SDK for Flutter
   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
           private async Task GetOfflinePreplannedMap()
           {
               var portal = await ArcGISPortal.CreateAsync();
               var portalItem = await PortalItem.CreateAsync(portal, "YOUR_ITEM_ID"); // Replace with your web map ID
               var map = new Map(portalItem);
   
               OfflineMapTask offlineMapTask = await OfflineMapTask.CreateAsync(map);
               IReadOnlyList<PreplannedMapArea> availableAreas = await offlineMapTask.GetPreplannedMapAreasAsync();
   
               if (availableAreas?.FirstOrDefault() is PreplannedMapArea area)
               {
                   DownloadPreplannedOfflineMapParameters downloadParameters = await offlineMapTask.CreateDefaultDownloadPreplannedOfflineMapParametersAsync(area);
   
                   string documentsFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
                   _downloadLocation = System.IO.Path.Combine(documentsFolder, "OfflineMap");
   
                   DownloadPreplannedOfflineMapJob job = offlineMapTask.DownloadPreplannedOfflineMap(downloadParameters, _downloadLocation);
                   DownloadPreplannedOfflineMapResult result = await job.GetResultAsync();
   
                   if (result?.OfflineMap is Map offlineMap)
                   {
                       this.Map = offlineMap;
                   }
               }
           }
   
2. When you display a previously downloaded offline map from your local storage. This does not require a network connection.
   ArcGIS Maps SDK for .NETArcGIS Maps SDK for .NETArcGIS Maps SDK for KotlinArcGIS Maps SDK for SwiftArcGIS Maps SDK for JavaArcGIS Maps SDK for QtArcGIS Maps SDK for Flutter
   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
               var mobileMapPackage = await MobileMapPackage.OpenAsync(_downloadLocation);
   
               await mobileMapPackage.LoadAsync();
   
               this.Map = mobileMapPackage.Maps.First();
   

When your offline applicationAn offline application, also known as offline app, is an application that runs on a phone, tablet, laptop or desktop device with limited or no network connection. Offline applications are built with ArcGIS Maps SDKs for Native Apps.Learn more no longer needs an offline mapAn offline map is a map area and its data content downloaded from an offline-enabled web map for use in offline applications built with ArcGIS Maps SDKs for Native Apps.Learn more, it is recommended that you unregister any feature data contained in the offline map. However, you do not need to unregister if the offline map is read-only. This process is also known as geodatabase unregistration.

Code examples

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
        private async Task GetOfflinePreplannedMap()
        {
            var portal = await ArcGISPortal.CreateAsync();
            var portalItem = await PortalItem.CreateAsync(portal, "YOUR_ITEM_ID"); // Replace with your web map ID
            var map = new Map(portalItem);

            OfflineMapTask offlineMapTask = await OfflineMapTask.CreateAsync(map);
            IReadOnlyList<PreplannedMapArea> availableAreas = await offlineMapTask.GetPreplannedMapAreasAsync();

            if (availableAreas?.FirstOrDefault() is PreplannedMapArea area)
            {
                DownloadPreplannedOfflineMapParameters downloadParameters = await offlineMapTask.CreateDefaultDownloadPreplannedOfflineMapParametersAsync(area);

                string documentsFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
                _downloadLocation = System.IO.Path.Combine(documentsFolder, "OfflineMap");

                DownloadPreplannedOfflineMapJob job = offlineMapTask.DownloadPreplannedOfflineMap(downloadParameters, _downloadLocation);
                DownloadPreplannedOfflineMapResult result = await job.GetResultAsync();

                if (result?.OfflineMap is Map offlineMap)
                {
                    this.Map = offlineMap;
                }
            }
        }

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
        private async Task SetupMap()
        {
            // Create a portal pointing to ArcGIS Online.
            ArcGISPortal portal = await ArcGISPortal.CreateAsync();

            // Create a portal item for a specific web map id.
            string webMapId = "YOUR_ITEM_ID"; // Replace with your web map ID
            PortalItem mapItem = await PortalItem.CreateAsync(portal, webMapId);

            // Create the map from the item.
            Map map = new Map(mapItem);

            // Set the view model "Map" property.
            this.Map = map;

            // Define area of interest (envelope) to take offline.
            EnvelopeBuilder envelopeBldr = new EnvelopeBuilder(SpatialReferences.Wgs84)
            {
                XMin = -118.5064,
                XMax = -118.4800,
                YMin = 34.0094,
                YMax = 34.0259
            };

            Envelope offlineArea = envelopeBldr.ToGeometry();

            // Create an offline map task using the current map.
            OfflineMapTask offlineMapTask = await OfflineMapTask.CreateAsync(map);

            // Create a default set of parameters for generating the offline map from the area of interest.
            GenerateOfflineMapParameters parameters = await offlineMapTask.CreateDefaultGenerateOfflineMapParametersAsync(offlineArea);
            parameters.UpdateMode = GenerateOfflineMapUpdateMode.NoUpdates;

            // Build a folder path named with today's date/time in the "My Documents" folder.
            string documentsFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
            string downloadDirectory = System.IO.Path.Combine(documentsFolder, "OfflineMap_" + DateTime.Now.ToFileTime().ToString());

            GenerateOfflineMapJob generateJob = offlineMapTask.GenerateOfflineMap(parameters, downloadDirectory);

            generateJob.ProgressChanged += GenerateJob_ProgressChanged;

            generateJob.Start();

        }

        private async void GenerateJob_ProgressChanged(object? sender, EventArgs e)
        {

            try
            {
                var generateJob = sender as GenerateOfflineMapJob;
                if(generateJob == null) { return; }

                // If the job succeeds, show the offline map in the map view.
                if (generateJob.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Succeeded)
                {
                    var result = await generateJob.GetResultAsync();
                    this.Map = result.OfflineMap;
                    Debug.WriteLine("Generate offline map: Complete");
                }
                // If the job fails, notify the user.
                else if (generateJob.Status == Esri.ArcGISRuntime.Tasks.JobStatus.Failed)
                {
                    MessageBox.Show($"Unable to generate a map for that area: {generateJob?.Error?.Message}");
                }
                else
                {
                    int percentComplete = generateJob.Progress;
                    Debug.WriteLine($"Generate offline map: {percentComplete}%");
                }

            }
            catch (Exception ex)
            {
                MessageBox.Show($"Error generating offline map: {ex.Message}");
            }

        }

Tutorials

ToolsAPIs

Create an offline-enabled web map

Use Map Viewer and the ArcGIS portal to create an offline-enabled web map.

ArcGIS portalMap Viewer

Create an offline map area

Use your portal to create an offline map area from an offline-enabled web map.

ArcGIS portal

Create a mobile map package

Use ArcGIS Pro to create a mobile map package.

ArcGIS Pro

Workflows

Create an app using a web map (ahead of time)

Learn how to build an offline app using an offline-enabled web map using the ahead-of-time method.

Create an app using a web map (on-demand)

Learn how to build an offline app using an offline-enabled web map using the on-demand method.

Create an app using a web map with layers (ahead of time)

Learn how to build an offline app using an offline-enabled web map and feature layer using the ahead-of-time method.

Create an app using a web map with layers (on-demand)

Learn how to build an offline app using an offline-enabled web map and feature layer using the on-demand method.