Skip To Content ArcGIS for Developers Sign In Dashboard

Loadable QML Type

Marker interface inherited by classes that can load data aynchronously. More...

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

Properties

Signals

Methods

Detailed Description

Base type for types whose objects can load data asynchronously, for example, from a remote network location or the local file system. Call load() to initiate loading. The loadStatus() property reflects the status of the load operation.

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 from an ArcGIS service, such as a feature in a ServiceFeatureTable

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

A layer that displays ArcGIS tiled map services and cached image services

ArcGISVectorTiledLayer

A vector tiled layer

Basemap

A basemap that can be displayed in a map

BasemapDarkGrayCanvasVector

A Basemap based on the Esri vector basemap Dark Gray Canvas

BasemapImagery

A Basemap based on the Esri basemap World Imagery

BasemapImageryWithLabels

A Basemap based on the Esri basemap Imagery with Labels

BasemapImageryWithLabelsVector

A Basemap based on the Esri vector basemap Imagery Hybrid

BasemapLightGrayCanvas

A Basemap based on the Esri basemap Light Gray Canvas

BasemapLightGrayCanvasVector

A Basemap based on the Esri vector basemap Light Gray Canvas

BasemapNationalGeographic

A Basemap based on the Esri basemap National Geographic World Map

BasemapNavigationVector

A Basemap based on the Esri vector basemap World Navigation Map

BasemapOceans

A Basemap based on the Esri Ocean Basemap

BasemapOpenStreetMap

A Basemap based on the Esri basemap OpenStreetMap

BasemapStreets

A Basemap based on the Esri basemap World Street Map

BasemapStreetsNightVector

A Basemap based on the Esri vector basemap World Street Map Night

BasemapStreetsVector

A Basemap based on the Esri vector basemap World Street Map

BasemapStreetsWithReliefVector

A Basemap based on the Esri vector basemap Streets with Relief

BasemapTerrainWithLabels

A Basemap based on the Esri basemap Terrain with Labels

BasemapTerrainWithLabelsVector

A Basemap based on the Esri vector basemap Terrain with Labels

BasemapTopographic

A Basemap based on the Esri basemap World Topographic Map

BasemapTopographicVector

A Basemap based on the Esri vector basemap World Topographic

BingMapsLayer

A Bing Maps layer displays map content from a Bing Maps web service

ClosestFacilityTask

A task to find a closest facility route between facilities and incidents

DictionarySymbolStyle

A type of SymbolStyle that is used to obtain unique symbols from a given specification, such as MIL-STD-2525D (mil2525d)

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 can visualize ENC data

ExportTileCacheTask

A task to export and download tile packages from tiled map services and image services

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

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

ImageAdjustmentLayer

A Layer that supports image adjustments

ImageTiledLayer

A layer that displays tiled map services and cached image services

ItemResourceCache

An object containing information on resources associated with a vector tile cache

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 to display basemap contents of a mobile map package

MobileMapPackage

A mobile map package

MobileScenePackage

Instances of this class represent a mobile scene package ( file)

ModelSceneSymbol

A 3D marker symbol based on 3D models

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

OpenStreetMapLayer

A layer that displays OpenStreetMap map tiles

PictureFillSymbol

A fill symbol based on an image

PictureFillSymbolLayer

A picture fill symbol layer is a symbol layer intended for use with polygon geometries

PictureMarkerSymbol

A marker symbol based on an image

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

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 dataset from an individual layer or table in an ArcGIS map service or 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 mechanism to obtain symbols from a style (*.stylx) file

TileCache

A tile cache persisted on a device

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 class that represents a layer that requests images from a tiled image server on the Web

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 Tile 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.


loadStatusChanged()

Emitted when the loadStatus property of this object changes.


Method Documentation

void cancelLoad()

Cancels loading if it is in progress.

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 data for the object asynchronously.

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()

Tries to reload when an object has failed to load.

This method should be called judiciously. It should be called when:

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

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

  • If the object has not started loading, it will start loading.
  • If the object is already loading, it will continue to load. This method does nothing.
  • If the object has already loaded, this method does nothing.
  • If the object has already failed to load, tries again.


Feedback on this topic?