Show / Hide Table of Contents

Class PreplannedMapArea

Represents a single preplanned offline map area.

Inheritance
Object
PreplannedMapArea
Implements
ILoadable
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Esri.ArcGISRuntime.Tasks.Offline
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class PreplannedMapArea : ILoadable
Remarks

Preplanned map areas are specific work areas or major incident areas that are defined by an online map author. Each online map can contain a number of map areas. These can be provided in a list by the GetPreplannedMapAreasAsync() method. Each preplanned map area creates map content that is stored online. Download this map content by running a DownloadPreplannedOfflineMapJob. Create this job by passing the preplanned map area to the DownloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String) method.

To successfully load a PreplannedMapArea the PackagingStatus must be Complete.

Constructors

Name Description
PreplannedMapArea(PortalItem)

Initializes a new instance of the PreplannedMapArea class from the specified PortalItem.

Properties

Name Description
AreaOfInterest

Gets the area of interest Geometry bounding the preplanned map area.

LoadError

Gets the Exception associated with the last load error.

LoadStatus

Gets the load status.

PackageItems

Gets the portal items for packages related to this preplanned map area.

PackagingStatus

Gets a value that describes the packaging status of the online map area.

PortalItem

Gets the PortalItem that this preplanned map area was created from.

UpdateCapabilities

Gets a value that describes the methods for obtaining updates that are supported for this preplanned map area.

Methods

Name Description
CancelLoad()

Cancel loading metadata for the object.

CreateAsync(PortalItem)

Initializes a new instance of the PreplannedMapArea class from the specified PortalItem. The resulting map area will be loaded.

CreateAsync(PortalItem, CancellationToken)

Initializes a new instance of the PreplannedMapArea class from the specified PortalItem and allowing cancellation. The resulting map area will be loaded.

LoadAsync()

Load the metadata for the object asynchronously.

RetryLoadAsync()

Loads or retries loading metadata for the object asynchronously.

Events

Name Description
Loaded

Event that is raised when the object is done loading.

LoadStatusChanged

Event that is raised when the LoadStatus property changes.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 Android200
.NET 6.0 iOS200
.NET Framework100.2.1 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.2.1 - 100.15
iOS100.2.1 - 100.15
UWP100.2.1 - 200.0
In This Article
Back to top Copyright © 2022 Esri.