Method DownloadPreplannedOfflineMap
DownloadPreplannedOfflineMap(PreplannedMapArea, String, Boolean)
Returns a job that is used to download the specified preplanned map area of an online map but excludes the map's basemap.
Declaration
[Obsolete("Use DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, string)")]
public DownloadPreplannedOfflineMapJob DownloadPreplannedOfflineMap(PreplannedMapArea preplannedMapArea, string downloadDirectoryPath, bool excludeBasemap)Parameters
| Type | Name | Description |
|---|---|---|
| PreplannedMapArea | preplannedMapArea | The PreplannedMapArea to be downloaded. |
| System.String | downloadDirectoryPath | The path to a folder where the map content is stored on the device. For example, to create a new mobile map package "my_mobile_map_package" in a parent directory "[my root path]/my_mobile_maps", this property would be "[my root path]/my_mobile_maps/my_mobile_map_package". |
| Boolean | excludeBasemap | A boolean indicating whether to exclude the basemap from the offline map. |
Returns
| Type | Description |
|---|---|
| DownloadPreplannedOfflineMapJob | A DownloadPreplannedOfflineMapJob for downloading the preplanned map area. |
Remarks
The job that is returned is dormant and needs to be explicitly started. The job will fail if the last directory in
the downloadDirectoryPath cannot be created or is not empty. Specifying
excludeBasemap: true will override the authored settings of the preplanned map area and
always exclude the basemap content.
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.2.1 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.2.1 - 100.15 |
| Xamarin.iOS | 100.2.1 - 100.15 |
| UWP | 100.2.1 - 100.15 |
DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String)
Returns a job that is used to download the PreplannedMapArea specified by the given parameters object.
Declaration
public DownloadPreplannedOfflineMapJob DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters parameters, string downloadDirectoryPath)Parameters
| Type | Name | Description |
|---|---|---|
| DownloadPreplannedOfflineMapParameters | parameters | Specifies parameters for the job including the PreplannedMapArea to be downloaded. |
| System.String | downloadDirectoryPath | The path to a folder where the map content is stored on the device. For example, to create a new mobile map package "my_mobile_map_package" in a parent directory "[my root path]/my_mobile_maps", this property would be "[my root path]/my_mobile_maps/my_mobile_map_package". |
Returns
| Type | Description |
|---|---|
| DownloadPreplannedOfflineMapJob | A DownloadPreplannedOfflineMapJob for downloading the preplanned map area. |
Remarks
The job that is returned is dormant and needs to be explicitly started. The job will fail if the last directory in the download directory path cannot be created or is not empty.
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.4 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.4 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.4 - 100.15 |
| Xamarin.iOS | 100.4 - 100.15 |
| UWP | 100.4 - 100.15 |