Skip To Content ArcGIS for Developers Sign In Dashboard

PreplannedMapArea QML Type

Represents a single preplanned offline map area. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.2
Inherits:

Object

Properties

Signals

Methods

Detailed Description

Preplanned map areas are specific work areas or major incident areas that are defined by an online map author. Each online map can contain several map areas. These can be provided in a list by the OfflineMapTask::preplannedMapAreas 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 OfflineMapTask::downloadPreplannedOfflineMap method on the task.

See also Cancelable.

Property Documentation

areaOfInterest : Geometry

Returns the area of interest bounding the preplanned map area (read-only).

The area of interest is returned as a Geometry which can be either an Envelope or a Polygon depending on how the online map was created.


contentItemsResult : ImmutablePortalItemListModel

Returns an immutable list of portal items fetched by a contentItems operation (read-only).

Obtain this property after the contentItemsStatusChanged signal emits, and the contentItemsStatus is Enums.TaskStatusCompleted.

This property was introduced in Esri.ArcGISRuntime 100.3.


contentItemsStatus : PortalItem

Returns the status of the contentItems asynchronous operation (read-only).

Check this status when the contentItemsStatusChanged signal emits, to determine if the operation is complete, in progress, or has errored.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also Enums.TaskStatus.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


packagingStatus : Enums.PreplannedPackagingStatus

Describes the publishing status of the online map area (read-only).

This property allows you to check if an online PreplannedMapArea is in a Enums.PreplannedPackagingStatusComplete state and ready to be downloaded.

There are four possible values:

If you attempt to download a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete the DownloadPreplannedOfflineMapJob will fail with Error::code 7022.

If you attempt to create a set of DownloadPreplannedOfflineMapParameters by calling OfflineMapTask::createDefaultDownloadPreplannedOfflineMapParameters from a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete, the operation will also fail with Error::code 7022.

If the packaging status is Enums.PreplannedPackagingStatusProcessing you can check it again following these steps:

This property was introduced in Esri.ArcGISRuntime 100.9.


portalItem : PortalItem

Returns the portal item that this preplanned map area was created from.


updateCapabilities : OfflineMapUpdateCapabilities

Describes what methods for obtaining updates are supported for this preplanned map area (read-only).

This property will return an empty OfflineMapUpdateCapabilities until loaded.

This property was introduced in Esri.ArcGISRuntime 100.6.


Signal Documentation

contentItemsStatusChanged()

Emitted when the contentItemsStatus property changes.

Note: The corresponding handler is onContentItemsStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.


loadErrorChanged()

Emitted when the loadError property changes.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


portalItemChanged()

Emitted when the portalItem property changes.

Note: The corresponding handler is onPortalItemChanged.

See also PortalItem.


updateCapabilitiesChanged()

Emitted when the updateCapabilities property changes.

Note: The corresponding handler is onUpdateCapabilitiesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


Method Documentation

void cancelLoad()

See also Loadable.


bool cancelTask(taskId)

Cancel the task with the ID taskId.

Returns false if the task cannot be cancelled or there is no task with the specified id taskId.

This method was introduced in Esri.ArcGISRuntime 100.3.

See also Cancelable.


string contentItems()

Starts a task that fetches the content items for this preplanned map area.

This method populates an ImmutablePortalItemListModel with the content items for this preplanned area.

The list model is returned to the app through the property contentItemsResult. Monitor the signal contentItemsStatusChanged. When the status changes to Enums.TaskStatusCompleted, the contentItemsResult property is populated. The results of this operation are cached, so the same portal item instances will be returned with each subsequent call of this method.

Returns a task ID that can be used to cancel the contentItems task.

This method was introduced in Esri.ArcGISRuntime 100.3.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?