GeoModel QML Type

Map and Scene that contains layers and properties and can be displayed in a GeoView."> GeoModel QML Type | ArcGISQtQml
  • Esri.ArcGISRuntime
  • GeoModel
  • A base class for Map and Scene that contains layers and properties and can be displayed in a GeoView. More...

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


    Inherited By:

    Map and Scene




    Detailed Description

    This base class represents the model in a model-view-controller (MVC) architecture, while the GeoView represents the view. To display a map or scene to the user, pass GeoModel to its appropriate GeoView, as follows:

    GeoModel has many properties that are common to both maps and scenes. For example:

    • Each map or scene typically has a basemap to help orient the users.
    • The operationalLayers collection gives you access to the vector data (points, line, polygons), raster data, and attribute information provided by the Map or Scene.
    • The spatialReference determines how spatial data relates to real-world space.

    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

    The basemap for this map or scene.

    A basemap provides a background of geographical context for the content you display in a map or scene. It is an optional set of non-editable layers such as aerial imagery, roads, or landmarks, that help orient the user of the map or scene.

    A basemap is composed of a collection of base layers (Basemap::baseLayers) and reference layers (Basemap::referenceLayers). Base layers are displayed at the bottom of a map or scene, and reference layers are displayed at the top, with the operationalLayers between them.

    You can use ready-to-use basemaps, style your own basemaps with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.

    [default] bookmarks : BookmarkListModel

    The collection of bookmarks defined for this map or scene.

    Bookmarks allow users to quickly navigate to a particular area of interest in a map or scene.

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

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

    See also GeoModel::floorManager.

    [read-only] floorManager : FloorManager

    Manages the data displayed for a floor-aware map or scene, allowing filtering based on floor levels (read-only).

    A FloorManager must be loaded before you can access its site, facility, and level properties, and perform floor filtering.

    When a map's floor manager is loaded, floor-aware layers display only data associated with the ground floor by default. When a scene's floor manager is loaded, floor-aware layers display data from all floors by default. You can filter the data displayed by floor-aware layers by toggling the FloorLevel::visible property of levels in the floor manager.

    [read-only, since Esri.ArcGISRuntime 100.14] geotriggersInfo : GeotriggersInfo

    Information about 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.

    These basemaps are secured and require either an API key or named user to access them.

    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 when the map or scene is first displayed.

    The initial viewpoint value is available when the map or scene is loaded. If you want to change the initial viewpoint, you can do this before you add the map or scene to a GeoView. At this point, the GeoView's viewpoint is set to this initial viewpoint. Any subsequent changes to the initialViewpoint are ignored.

    If you want to change the viewpoint of a displayed map or scene, use GeoView methods such as:

    [default] item : ArcGISItem

    The ArcGIS item associated with this map or scene.

    This can be a PortalItem (for web maps and web scenes loaded from a portal or saved to a portal), or a LocalItem (for maps in a map package or scenes in a scene package), or null if no ArcGISItem is associated with this map or scene.

    [read-only] legendInfos : LegendInfoListModel

    Returns the list model containing legend infos for the geo model's operational layers (read-only).

    [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

    The properties that control the default loading and rendering behavior of feature layers in this map or scene.

    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.

    See also LoadSettings::featureTilingMode and LoadSettings::useAdvancedSymbology.

    [read-only] loadStatus : Enums.LoadStatus

    Returns the load status (read-only).

    See also Loadable and Enums.LoadStatus.

    [default] operationalLayers : LayerListModel

    A collection of layers that can access geographic data from a file or a service.

    The operational layers collection is used to display geographic data layers on top of a basemap layer in a Map or Scene. For example, you can display a fleet of vehicles being tracked on a map or display a point cloud layer of a tree canopy in a scene.

    This collection of layers is unique to the map or scene, it cannot be used by another GeoModel. You can add and remove layers from the map or scene by adding and removing them from this collection. Ensure that the map has finished loading, otherwise you will replace the map's original operational layers with the newly added layers.

    The first layer in the operationalLayers collection is drawn first (on the bottom) above the basemap layer. Each subsequent layer is drawn on top. Typically, imagery or tile layers are added to the collection first, and then polygon, line, and point layers last. When you pass the GeoModel to the GeoView it combines these layers to create the final display for the user.

    See Data Layers for more information about working with operational layers.

    See also Basemap::baseLayers.

    [read-only] spatialReference : SpatialReference

    The spatial reference for this map or scene (read-only).

    The spatial reference is 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.

    SpatialReference specifies how geometry coordinates relate to real-world space. It ensures that you can accurately view, query, and analyze the layers of a map or scene.

    The spatial reference value is null until the Map or Scene is loaded.

    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 collection of feature tables in the map or scene. Unlike operationalLayers, tables are not displayed by the GeoView.

    The collection of feature tables is specific to the map or scene. You can add and remove tables by adding or removing them from the collection.

    By default, the tables are not loaded. You can load them explicitly via (FeatureTable::load) or load them by calling methods such as FeatureTable::queryFeatures(QueryParameters).

    [read-only] 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 that include transportation networks. If the map or scene is created from one of these packages, this collection will be populated with a read-only 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.

    [read-only] version : string

    The version of the Map or Scene when it is loaded. The version of a newly created Map or Scene is empty (read-only).

    When you load an existing map or scene, the version value is the version that it was created at, according to the [ESRI web map specification or ESRI web scene specification, respectively.

    You can make changes to a map (associated with a PortalItem) and save it back to the web map it originated from. Alternatively, you can save a map as a new web map on a specified Portal with a given title and folder. In these cases, the version of the saved map will be the version of the [ESRI web map specification supported by this API. You cannot save changes to maps in mobile map packages.

    Saving changes to scenes is not currently supported.

    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.

    [since Esri.ArcGISRuntime 200.1] bool equals(GeoModel other)

    Determines if this GeoModel object is equal to a second GeoModel object.

    Returns whether this instance and other are equivalent.

    This method was introduced in Esri.ArcGISRuntime 200.1.

    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.