ArcGIS Developers

PreplannedMapAreaListModel QML Type

The list of preplanned map areas available obtained from an offline map task. More...

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




  • bool contains(PreplannedMapArea area)
  • void forEach(callback)
  • PreplannedMapArea get(int index)
  • int indexOf(PreplannedMapArea area)

Detailed Description

The model returns data for the following roles:

itemTitlestringThe title of the portal item for the map area.
itemIdstringThe Id of the porta item for the map area.
itemDescriptionstringThe description of the portal item for the map area.
itemThumbnailUrlurlThe thumbnail of the portal item as a local file URL.

See also OfflineMapTask, PreplannedMapArea, and PortalItem.

Property Documentation

count : int

Returns the number of objects in the model (read-only).

Signal Documentation


Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.

Method Documentation

bool contains(PreplannedMapArea area)

Returns true if the list model contains the specified area.

void forEach(callback)

Receives a callback function to execute for each PreplannedMapArea in the model.

The callback function can take 0 to 3 optional arguments, in order:

Returns undefined if no error occurred, and an error message otherwise.

const error = preplannedMapAreaListModel.forEach(function(element, index, array) {
if (error) {

PreplannedMapArea get(int index)

Returns the PreplannedMapArea at the specified index.

int indexOf(PreplannedMapArea area)

Returns the index of a specific preplanned area (area) from the list model.

This method was introduced in Esri::ArcGISRuntime 100.5..

Feedback on this topic?