PreplannedMapArea QML Type

  • Esri.ArcGISRuntime
  • PreplannedMapArea
  • Represents a single preplanned offline map area. More...

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





    Detailed Description

    Offline map areas are specific work areas or major incident areas that are defined by an online map author ahead of time. Each online map can contain a number of offline map areas. These can be provided in a list by the OfflineMapTask::preplannedMapAreas method.

    Each offline map area uses map content that is stored online. Download this map content by running a DownloadPreplannedOfflineMapJob. Create this job by passing the offline map area to the OfflineMapTask::downloadPreplannedOfflineMapWithParameters method on the OfflineMapTask.

    To successfully load a PreplannedMapArea the PreplannedMapArea::packagingStatus must be Enums.PreplannedPackagingStatusComplete.

    See also Cancelable.

    Property Documentation

    [read-only] areaOfInterest : Geometry

    Returns the area of interest bounding the offline 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.

    [read-only] 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.

    [read-only] loadStatus : Enums.LoadStatus

    Returns the load status (read-only).

    See also Loadable and Enums.LoadStatus.

    [read-only, since Esri.ArcGISRuntime 100.14] packageItems : list<PortalItem>

    Portal items for packages related to this (read-only).

    When the offline map area has successfully loaded, this collection contains the portal items for the packages (tile packages or geodatabases) holding the offline data for the offline map area.

    This property was introduced in Esri.ArcGISRuntime 100.14.

    [read-only, since Esri.ArcGISRuntime 100.9] 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.

    If you attempt to load a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete the PreplannedMapArea will fail to load with an error of Enums.ErrorTypeCommonIllegalState.

    There are four possible values:

    If you attempt to download a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete the DownloadPreplannedOfflineMapJob will fail with Enums.ErrorTypeMappingPackagingNotComplete.

    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 Enums.MappingPackagingNotComplete.

    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 offline map area was created from.

    [read-only, since Esri.ArcGISRuntime 100.6] updateCapabilities : OfflineMapUpdateCapabilities

    Describes the methods for obtaining updates that are supported for this offline map area (read-only).

    There are two approaches for updating the features in a preplanned offline map area:

    • Syncing directly with feature services.
    • Downloading scheduled updates (or update packages) from the online map area.

    Choose the approach that best suits your workflow, then select the appropriate DownloadPreplannedOfflineMapParameters::updateMode. For more details on how to update an offline map, see the OfflineMapSyncTask.

    If OfflineMapUpdateCapabilities::supportsSyncWithFeatureServices is true, you can sync directly with feature services. This mode gives you full control over when you upload and download changes. However, performing a download sync places significant load on the backing feature service, so this approach does not scale well for very large deployments. Set the DownloadPreplannedOfflineMapParameters::updateMode to Enums.PreplannedUpdateModeSyncWithFeatureServices to use this approach.

    If OfflineMapUpdateCapabilities::supportsScheduledUpdatesForFeatures is true, you can download read-only update packages from the online map area. Updates are prepared on a regular schedule and cached for download by all users of the offline map area. Sharing a single set of cached updates, rather than performing individual sync operations, reduces the load on the back-end services. This approach is scalable for large deployments but does not support offline editing. Set the DownloadPreplannedOfflineMapParameters::updateMode to Enums.PreplannedUpdateModeDownloadScheduledUpdates to use this approach.

    Note that scheduled updates is an optimization that must be enabled by the web map author when the map area is created.

    If both of the above OfflineMapUpdateCapabilities are true, and the feature services in your online map support creating new features, you can adopt a hybrid update model where you download read-only update packages while uploading new features directly to the feature service. This approach combines the scalability of downloading scheduled updates with the ability to collect data in the field. However, note that this approach is strictly add only, meaning that you cannot delete or edit features once they have been uploaded to the feature service. Set the DownloadPreplannedOfflineMapParameters::updateMode to Enums.PreplannedUpdateModeDownloadScheduledUpdatesAndUploadNewFeatures to use this approach.

    This property will return null until the offline map area is loaded.

    This property was introduced in Esri.ArcGISRuntime 100.6.

    Signal Documentation


    Emitted when the loadError property changes.

    Note: The corresponding handler is onLoadErrorChanged.

    See also Loadable and Object.


    Emitted when the loadStatus property changes.

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.

    [since Esri.ArcGISRuntime 100.9] packagingStatusChanged()

    Emitted when the packagingStatus property changes.

    Note: The corresponding handler is onPackagingStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.9.


    Emitted when the portalItem property changes.

    Note: The corresponding handler is onPortalItemChanged.

    See also PortalItem.

    [since Esri.ArcGISRuntime 100.6] 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.

    [since Esri.ArcGISRuntime 100.3] bool cancelTask(string taskId)

    Cancel the task with the ID taskId.

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

    This method was introduced in Esri.ArcGISRuntime 100.3.

    See also Cancelable.

    void load()

    See also Loadable.

    void retryLoad()

    See also Loadable.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.