Loadable QML Type

An interface for asynchronously loading data to initialize an object. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.0

List of all members, including inherited members

Properties

loadError : Error
loadStatus : Enums.LoadStatus

Signals

loadErrorChanged()
loadStatusChanged()

Methods

void cancelLoad()
void load()
void retryLoad()

Detailed Description

A resource that is capable of loading its metadata asynchronously is referred to as a loadable. Such a resource could represent a remote service or a dataset on disk.

All classes that implement Loadable include two signals.

void Loadable::doneLoading(Esri::ArcGISRuntime::Error error)

error - The load error if any error occurred.

void Loadable::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

loadStatus - An enumeration indicating load status.

Types that implement Loadable

ArcGISFeature	A Feature stored in an ArcGISFeatureTable
ArcGISFeatureTable	A feature table created from an ArcGIS feature service
ArcGISMapImageLayer	A layer based on a dynamic ArcGIS Map service
ArcGISSceneLayer	A layer that displays 3D features from a scene service
ArcGISSublayer	A sublayer of a Layer
ArcGISTiledElevationSource	A tile based elevation source
ArcGISTiledLayer	Displays data from a ArcGIS Map service, by using pre-generated tiles
ArcGISVectorTiledLayer	Displays data from an ArcGIS vector tiled data source
ArcadeEvaluator	This object allows you to evaluate an ArcadeExpression under a given Enums.ArcadeProfile
Basemap	A basemap that can be displayed in a map
BingMapsLayer	A Bing Maps layer displays map content from a Bing Maps web service, providing access to static map tiles and imagery metadata
ClosestFacilityTask	A task to find a closest facility route between facilities and incidents
ContingentValuesDefinition	An object that defines a contingent values definition
ElevationSource	Base class for elevation source classes such as ArcGISTiledElevationSource
EncCell	A single Electronic Navigation Chart (ENC) data source object
EncExchangeSet	An Electronic Navigation Chart (ENC) exchange set object
EncLayer	A layer that displays ENC data
ExportTileCacheTask	A task used to export a tile cache (.tpk or .tpkx)
ExportVectorTilesTask	A task used to export vector tiles and their style resources
FeatureCollection	A container for a collection of FeatureCollectionTables
FeatureLayer	A layer that can display features from a FeatureTable on a map
FeatureTable	Base type for types that represent a table of features
FloorManager	Manages the data displayed by a floor-aware map or scene, allowing filtering based on floor levels
GeoModel	A base class for either a Map or a Scene
GeoPackage	Open, standards-based, compact format for transferring geospatial information
Geodatabase	A mobile geodatabase on the local file system
GeodatabaseFeatureTable	A feature table coming from a geodatabase
GeodatabaseSyncTask	A task to download and sync a sync-enabled mobile geodatabase
GeoprocessingTask	Used to run a geoprocessing task that is published as a web service
GeotriggersInfo	Presents information on a set of Geotrigger objects defined for a GeoModel
ImageAdjustmentLayer	A Layer that supports image adjustments
ImageFrame	A frame that, when added to an ImageOverlay, renders an image on top of a scene
ImageTiledLayer	A base type for layers that display cached maps
ItemResourceCache	Contains information on offline resources, typically associated with a custom style for an ArcGISVectorTiledLayer
KmlDataset	Contains the current state of the KML data specified in a KML/KMZ file
Layer	Base type for layer types
LocatorTask	A task for Geocoding and Reverse Geocoding that supports both online and offline capabilities
Map	A map which can be displayed on the screen using a map view
MobileBasemapLayer	A layer that can display the basemap layer of a map from mobile map package
MobileMapPackage	A mobile map package
MobileScenePackage	Instances of this class represent a mobile scene package (.mspk file)
ModelSceneSymbol	Used to display Point or Multipoint GeoElements in a scene using a 3D model
MosaicDatasetRaster	A geodatabase model designed for managing a collection of raster images
OfflineMapSyncTask	A task with methods related to synchronizing an offline map's geodatabases with their originating services
OfflineMapTask	A task with methods related to taking a map offline and synchronizing online and offline maps
OgcFeatureService	An OGC API - Features service
OpenStreetMapLayer	A layer that displays OpenStreetMap map tiles
PictureFillSymbol	Uses an image to symbolize the fill for a Polygon GeoElement
PictureFillSymbolLayer	A symbol layer that fills polygon geometry with an image
PictureMarkerSymbol	Uses an image to symbolize GeoElements that have Point or Multipoint
PictureMarkerSymbolLayer	Represents a symbol layer used to place a picture marker on a point geometry
PopupAttachment	An attachment to a Popup, which contains the attachment data and some additional metadata about the attachment
Portal	Represents a view into a portal by a user, either anonymous or with a Credential
PortalGroup	Represents a group within a Portal or Organization
PortalItem	An item in a portal
PortalUser	Represents a registered user of a portal or organization
PreplannedMapArea	Represents a single preplanned offline map area
Raster	Represents raster data that can be rendered using a RasterLayer
RasterElevationSource	A file-based raster elevation source
RasterFunction	An operation that can be performed on one or more rasters or a mosaic dataset by applying on-the-fly processing
RasterFunctionArguments	Represents arguments associated with a raster function
RasterLayer	A RasterLayer is used to render data from a Raster onto a Map
RouteTask	A task to find a Route between two or more locations
Scene	A scene which can be displayed on the screen using a scene view
ServiceAreaTask	A task to compute areas that can be serviced (reached) from a given location
ServiceFeatureTable	A feature table created from the URL to an ArcGIS feature service
ServiceGeodatabase	A container for a collection of ServiceFeatureTable instances connected to a feature service
ServiceImageTiledLayer	A base class for all image tiled layers that fetches map tiles from a remote service
Surface	Class containing elevation sources
SymbolStyle	A symbol style object
TileCache	A local cache of pre-rendered map tiles that can be used to create a layer
UnknownLayer	An instance of this class represents a layer whose type could not be determined
UnsupportedLayer	An instance of this class represents a layer whose type could not be determined
UtilityNetwork	A utility network
VectorTileCache	This class represents the metadata for a local cache of vector map tiles that can be used to create an ArcGISVectorTiledLayer
WebTiledLayer	A layer that requests images from a tiled image server based on a URL template
WfsFeatureTable	A table in an OGC Web Feature Service
WfsService	An OGC Web Feature Service (WFS)
WmsLayer	Defines an Open Geospatial Consortium (OGC) Web Map Service (WMS) layer
WmsService	Represents an OGC Web Map Service (WMS)
WmtsLayer	Defines an Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS) layer
WmtsService	An Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS)
WmtsServiceInfo	Represents the service metadata for an Open Geospatial Consortium (OGC) Web Map Tile Service (WMTS)

See also loadError and loadStatus.

Property Documentation

loadError : Error

Returns the error of this Loadable object (read-only).

See also Error.

loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Loadable object.

Signal Documentation

loadErrorChanged()

Emitted when the loadError property of this Loadable object changes.

Note: The corresponding handler is onLoadErrorChanged.

loadStatusChanged()

Emitted when the loadStatus property of this object changes.

Note: The corresponding handler is onLoadStatusChanged.

Method Documentation

void cancelLoad()

Cancels loading the metadata if the object is loading.

The effect of calling this method depends on the load status of the object:

If this object is loading, it will stop loading.
If this object is not loading, this method does nothing.

void load()

Loads metadata for the object asynchronously.

Loads the metadata if the object is not loaded. The Loadable::loadStatus property reflects the status of the load operation. You can call this method any number of times. However, only one attempt is made to load the data. The effect of calling this method depends on the load status of the object:

If the object has not started loading, it will start to load.
If the object is already loading, it will continue to load. This method does nothing.
If the object has already loaded successfully, this method does nothing.
If the object has already failed to load, this method does nothing. You can try loading the object again by calling retryLoad().

void retryLoad()

Loads or retries loading metadata for the object asynchronously.

Will retry loading the metadata if the object failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

This method should be called when the issues which resulted in an earlier load failure have been resolved. For example, it should be called when:

You didn't have network connectivity earlier when loading failed and you want to retry now that you have connectivity.
The server was down earlier when loading failed and you want to retry.
The request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad() and then this method.