The list of preplanned map areas available obtained from an offline map task. More...
|  Header |  #include <Preplanned | 
|  Since |  Esri | 
|  Inherits |  QAbstract | 
This class was introduced in Esri::ArcGISRuntime 100.2.
Public Types
| enum | Preplanned | 
Public Functions
| virtual | ~ | 
| bool | contains( | 
|  Esri | first() const | 
| int | index | 
| bool | is | 
|  Esri | last() const | 
Reimplemented Public Functions
|  virtual Esri | at(int index) const override | 
| virtual QVariant | data(const QModel | 
Detailed Description
The model returns data for the following roles:
| Role | Type | Description | PreplannedMapAreaRoles | 
|---|---|---|---|
| item | QString | The title of the portal item for the map area. | Item | 
| item | QString | The Id of the porta item for the map area. | Item | 
| item | QString | The description of the portal item for the map area. | Item | 
| item | QUrl | The thumbnail of the portal item as a local file UR | Item | 
See also OfflineMapTask, PreplannedMapArea, and PortalItem.
Member Type Documentation
enum PreplannedMapAreaListModel::PreplannedMapAreaRoles        
This enum specifies the custom roles which can be used with PreplannedMapAreaListModel::data.
| Constant | Value | Description | 
|---|---|---|
Esri | Qt | The title of the portal item for the map area. | 
Esri | Qt | The Id of the porta item for the map area. | 
Esri | Qt | The description of the portal item for the map area. | 
Esri | Qt | The thumbnail of the portal item as a local file UR | 
Member Function Documentation
[override virtual] PreplannedMapAreaListModel::~PreplannedMapAreaListModel     ()     
Destructor.
[override virtual] Esri::ArcGISRuntime::PreplannedMapArea      *PreplannedMapAreaListModel::at(int index) const      
Returns the map area at the specified index.
bool PreplannedMapAreaListModel::contains(Esri::ArcGISRuntime::PreplannedMapArea      *area) const     
Returns true if the provided area is in the list model.
[override virtual] QVariant PreplannedMapAreaListModel::data(const QModelIndex  &index, int role = Qt::DisplayRole) const       
Reimplements: QAbstractItemModel::data(const QModelIndex &index, int role) const.
Returns the data stored under the given role for the map area referred to by the index.
- index. The index in the model for which to return data.
 - role. The role for which to return data.
 
Esri::ArcGISRuntime::PreplannedMapArea      *PreplannedMapAreaListModel::first() const      
Returns the first map area in the list model.
int PreplannedMapAreaListModel::indexOf (Esri::ArcGISRuntime::PreplannedMapArea      *area) const     
Returns the index of the provided area in the list model.
bool PreplannedMapAreaListModel::isEmpty () const     
Returns true if this list model is empty.
Esri::ArcGISRuntime::PreplannedMapArea      *PreplannedMapAreaListModel::last() const      
Returns the last map area in the list model.