GeoModel QML Type

A base class for either a Map or a Scene. More...

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


Inherited By:

Map and Scene




Detailed Description

The base class GeoModel represents the model in a model-view-controller (MVC) architecture, while GeoView represents the view. Map and Scene derive from GeoModel.

You provide a GeoModel to the appropriate type of view:

Note: You cannot declare or create a component of this type in QML code.

See also Loadable.

Property Documentation

autoFetchLegendInfos : bool

Whether legend infos are automatically fetched by the geo model's operational layers.

Set to true (default is false) to have legend infos fetched automatically when the LegendInfoListModel is instantiated.

[default] basemap : Basemap

Optional layers in a map or scene that show background information—roads, landmarks, and so on—to help orient the user of the map or scene.

Typically image tile or vector tile layer types. Basemaps can be composed of different layers organized in Basemap::baseLayers (displayed beneath other layers) and Basemap::referenceLayers (displayed on top of other layers). You can use ready-to-use basemaps, style your own with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.

See also Basemap.

[default] bookmarks : BookmarkListModel

The bookmarks for the map or scene. The collection is specific to this GeoModel.

See also Bookmark.

error : Error

Returns the error object (read-only).

See also Loadable and Error.

floorDefinition : GeoModelFloorDefinition

Defines the properties that allow a map or a scene to be floor-aware.

Floor-aware maps and scenes contain data representing floor plan and indoor features. The data displayed by floor-aware maps and scenes can be filtered based on floor levels using the FloorManager. This property is null for maps or scenes that are not floor-aware. When this property is set, a new unloaded |l {GeoModel::floorManager} is instantiated.

Please note that upon setting this property, the floorManager is invalidated.

See also GeoModel::floorManager.

floorManager : FloorManager

Manages the data displayed for a floor-aware map or scene, allowing the data to be filtered based on floor levels.

This property is nullptr if the map/scene is not loaded or if the map/scene is not floor-aware. A FloorManager must be loaded before you can access its properties and perform floor filtering.

Please note that the floorManager is invalidated upon setting the floorDefinition.

See also FloorManager.

[since Esri.ArcGISRuntime 100.14] geotriggersInfo : GeotriggersInfo

An object that presents the set of Geotrigger objects defined for the map or scene (read-only).

You must load the GeotriggersInfo to populate the GeotriggersInfo::geotriggers with any geotriggers defined by the author of the map or scene. If no geotriggers were defined this list will remain empty.

Use a GeotriggerMonitor to check each of the conditions defined in GeotriggersInfo::geotriggers.

When you save the map or scene, any Geotrigger objects that reference local data (for example a GraphicsOverlayFenceParameters) will be omitted.

This property was introduced in Esri.ArcGISRuntime 100.14.

initBasemapStyle : Enums.BasemapStyle

The basemap style the map or scene was created from.

This can only be assigned one time and only during instantiation.

If the map or scene was created by some other means than this property, this value will return Enums.BasemapStyleNone.

initUrl : url

The URL used to initialize the geomodel.

This property can only be set once.

Note: Assigning the item property will not automatically make the initUrl property valid.

Note: Assigning this property will not create an item for use with the save methods that require a item.

The initUrl can be one of several possible types that refer to a PortalItem:

See also PortalItem, PortalItem::portal, and GeoModel::item.

[default] initialViewpoint : Viewpoint

The initial viewpoint for the map or scene. The visible area of a map or scene after the map or scene first loads. Your app uses it until you add the model, map, or scene to a view and set the viewpoint for the view. After the view has a viewpoint, this InitialViewpoint property is ignored.

To set the viewpoint for a view, you use a viewpoint method, such as one of the following.

[default] item : ArcGISItem

The item for the map or scene.

An ID for a resource, such as a PortalItem (for maps created from a portal) or a LocalItem (for maps and scenes in a map or scene package). Note that a map or scene cannot be instantiated from a LocalItem.

legendInfos : LegendInfoListModel

Returns the list model containing legend infos for the geo model's operational layers (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.

loadSettings : LoadSettings

Set default behaviors (preferences) and control the rendering behaviors for maps and scenes as they load.

Set preferences and control rendering behaviors when maps and scenes load. For example, you can specify which tiling mode should be used when feature layers are added, or specify whether feature tables should use advanced symbology.

loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.

[default] operationalLayers : LayerListModel

Layers that reference data from a file or a service and are typically used to visualize the data in a map or scene, for example, a fleet of vehicles being tracked on a map.

Operational layers, which display on top of the Basemap::baseLayers, are hosted and managed on the ArcGIS Platform as feature layers, KML layers, WFS layers, tile layers, and more. Several layer types can also be used by your ArcGIS Maps SDK app as local layers, such as feature layers and tiled layers. You cannot reuse a layer collection coming from a different map or scene. Instead, you must create a new collection of Layer.

See also Layer and Basemap::baseLayers.

spatialReference : SpatialReference

A well-known ID (WKID) integer value or a text string definition referred to as a well-known text (WKT) representation that identifies how a geometry's coordinates relate to real-world space (read-only).

Spatial reference ensures that spatial data in different layers or graphic overlays can be used together for accurate viewing or analysis.

See also SpatialReference.

[default] tables : FeatureTableListModel

A list of tables in the map or scene.

Unlike operationalLayers, Tables are not displayed by the GeoView. The collection is specific to this GeoModel. Tables can be added and removed from the GeoModel through this model. Tables are not loaded by default. Tables are loaded internally when asynchronous operations like query are performed. Alternatively, they can be loaded by calling FeatureTable::load.

See also FeatureTable.

transportationNetworks : list<TransportationNetworkDataset>

A collection of transportation network datasets defined for the map or scene (read-only).

Map and Scene authors can use ArcGIS Pro to create mobile map or scene packages containing maps and scenes that include transportation networks. If so, this property will be populated with the collection of TransportationNetworkDataset objects.

A TransportationNetworkDataset from this collection can be used to construct one of the network analysis tasks (such as RouteTask, ServiceAreaTask, and ClosestFacilityTask).

See also RouteTask and MobileScenePackage.

version : string

The version of the Map or Scene, read when it is opened.

The version that the map or scene is saved to might differ from the version it was opened at. The version saved depends on the ArcGIS Maps SDK version.

Signal Documentation


Emitted when the autoFetchLegendInfos property changes.

Note: The corresponding handler is onAutoFetchLegendInfosChanged.


Emitted when the basemap property changes.

Note: The corresponding handler is onBasemapChanged.


Emitted when the floorDefinition property changes.

Note: The corresponding handler is onFloorDefinitionChanged.


Emitted when the floorManager property changes.

Note: The corresponding handler is onFloorManagerChanged.


Emitted when the initBasemapStyle property changes.

Note: The corresponding handler is onInitBasemapStyleChanged.


Emitted when the initUrl property changes.

Note: The corresponding handler is onInitUrlChanged.


Emitted when the initialViewpoint property changes.

Note: The corresponding handler is onInitialViewpointChanged.


Emitted when the item property changes.

Note: The corresponding handler is onItemChanged.


Emitted when the loadError property changes.

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

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


Emitted when the loadSettings property changes.

Note: The corresponding handler is onLoadSettingsChanged.


Emitted when the loadStatus property of this GeoModel changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


Emitted when the spatialReference property changes.

Note: The corresponding handler is onSpatialReferenceChanged.


Emitted when the transportationNetworks property of this GeoModel changes.

Note: The corresponding handler is onTransportationNetworksChanged.


Emitted when the version property of this GeoModel changes.

This property may be populated after the GeoModel loads.

Note: The corresponding handler is onVersionChanged.

Method Documentation

void cancelLoad()

See also Loadable.

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.