Determine the map’s load status which can be: NotLoaded, FailedToLoad, Loading, Loaded, Unknown.

Use case
Knowing the map’s load state may be required before subsequent actions can be executed.
How to use the sample
Click on the button to reload the Map. The load status of the Map will be displayed on screen.
How it works
- Create a
Mapand add it to aMapView. - Connect to the
Map::loadStatusChangedsignal to query the map’s load status. TheLoadStatusisLoadStatus::Loadedwhen any of the following criteria are met:
- The map has a valid spatial reference.
- The map has an an initial viewpoint.
- One of the map’s predefined layers has been created.
Relevant API
- Map
- LoadStatusChanged
- MapView
Tags
LoadStatus, Map, Loadable pattern
Sample Code
// [WriteFile Name=MapLoaded, Category=Maps]// [Legal]// Copyright 2016 Esri.//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at// http://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License.// [Legal]
#ifdef PCH_BUILD#include "pch.hpp"#endif // PCH_BUILD
// sample headers#include "MapLoaded.h"
// ArcGIS Maps SDK headers#include "Basemap.h"#include "Map.h"#include "MapQuickView.h"#include "MapTypes.h"
using namespace Esri::ArcGISRuntime;
MapLoaded::MapLoaded(QQuickItem* parent) : QQuickItem(parent){}
MapLoaded::~MapLoaded() = default;
void MapLoaded::init(){ qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView"); qmlRegisterType<MapLoaded>("Esri.Samples", 1, 0, "MapLoadedSample");}
void MapLoaded::componentComplete(){ QQuickItem::componentComplete();
// find QML MapView component m_mapView = findChild<MapQuickView*>("mapView");
// create a new basemap instance Basemap* basemap = new Basemap(BasemapStyle::ArcGISStreets, this); // create a new map instance m_map = new Map(basemap, this); // set map on the map view m_mapView->setMap(m_map);
connect(m_map, &Esri::ArcGISRuntime::Map::loadStatusChanged, this, [this](Esri::ArcGISRuntime::LoadStatus loadStatus) { switch (loadStatus) { case LoadStatus::Loaded: m_loadStatus = "Map Load Status: Loaded"; break; case LoadStatus::Loading: m_loadStatus = "Map Load Status: Loading..."; break; case LoadStatus::FailedToLoad: m_loadStatus = "Map Load Status: Failed to Load"; break; case LoadStatus::NotLoaded: m_loadStatus = "Map Load Status: Not Loaded"; break; case LoadStatus::Unknown: m_loadStatus = "Map Load Status: Unknown"; break; } emit mapLoadStatusChanged(); });}
QString MapLoaded::mapLoadStatus() const{ return m_loadStatus;}// [WriteFile Name=MapLoaded, Category=Maps]// [Legal]// Copyright 2016 Esri.//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at// http://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License.// [Legal]
#ifndef MAP_LOADED_H#define MAP_LOADED_H
// Qt headers#include <QQuickItem>
namespace Esri::ArcGISRuntime{ class Map; class MapQuickView;}
class QString;
class MapLoaded : public QQuickItem{ Q_OBJECT
Q_PROPERTY(QString mapLoadStatus READ mapLoadStatus NOTIFY mapLoadStatusChanged)
public: explicit MapLoaded(QQuickItem* parent = nullptr); ~MapLoaded() override;
void componentComplete() override; static void init();
signals: void mapLoadStatusChanged();
private: QString mapLoadStatus() const;
private: Esri::ArcGISRuntime::Map* m_map = nullptr; Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr; QString m_loadStatus;};
#endif // MAP_LOADED_H// [WriteFile Name=MapLoaded, Category=Maps]// [Legal]// Copyright 2016 Esri.//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at// http://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License.// [Legal]
import QtQuickimport Esri.Samples
MapLoadedSample { id: mapLoadedSample width: 800 height: 600
// add a mapView component MapView { anchors.fill: parent objectName: "mapView"
Component.onCompleted: { // Set the focus on MapView to initially enable keyboard navigation forceActiveFocus(); } }
Rectangle { id: statusBar anchors { left: parent.left right: parent.right bottom: parent.bottom } height: 30 color: "lightgrey" border { width: 0.5 color: "black" }
Text { anchors { verticalCenter: parent.verticalCenter left: parent.left leftMargin: 10 } // Bind to the C++ property that returns the map's load status text: mapLoadedSample.mapLoadStatus font.pixelSize: 14 } }}// [Legal]// Copyright 2015 Esri.//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at// http://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License.// [Legal]
// sample headers#include "MapLoaded.h"
// ArcGIS Maps SDK headers#include "ArcGISRuntimeEnvironment.h"
// Qt headers#include <QCommandLineParser>#include <QDir>#include <QGuiApplication>#include <QQmlEngine>#include <QQuickView>#include <QSettings>
// Platform specific headers#ifdef Q_OS_WIN#include <Windows.h>#endif
#define STRINGIZE(x) #x#define QUOTE(x) STRINGIZE(x)
int main(int argc, char *argv[]){ Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setUseLegacyAuthentication(false); QGuiApplication app(argc, argv); app.setApplicationName(QString("MapLoaded"));
// Use of ArcGIS location services, such as basemap styles, geocoding, and routing services, // requires an access token. For more information see // https://links.esri.com/arcgis-runtime-security-auth.
// The following methods grant an access token:
// 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account. // To generate a token, a user logs in to the app with an ArcGIS account that is part of an // organization in ArcGIS Online or ArcGIS Enterprise.
// 2. API key authentication: Get a long-lived access token that gives your application access to // ArcGIS location services. Go to the tutorial at https://links.esri.com/create-an-api-key. // Copy the API Key access token.
const QString accessToken = QString("");
if (accessToken.isEmpty()) { qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires" << "you to authenticate with an ArcGIS account or set the API Key property."; } else { Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setApiKey(accessToken); }
// Initialize the sample MapLoaded::init();
// Initialize application view QQuickView view; view.setResizeMode(QQuickView::SizeRootObjectToView);
// Add the import Path view.engine()->addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml"));
QString arcGISRuntimeImportPath = QUOTE(ARCGIS_RUNTIME_IMPORT_PATH);
#if defined(LINUX_PLATFORM_REPLACEMENT) // on some linux platforms the string 'linux' is replaced with 1 // fix the replacement paths which were created QString replaceString = QUOTE(LINUX_PLATFORM_REPLACEMENT); arcGISRuntimeImportPath = arcGISRuntimeImportPath.replace(replaceString, "linux", Qt::CaseSensitive); #endif
// Add the Runtime and Extras path view.engine()->addImportPath(arcGISRuntimeImportPath);
// Set the source view.setSource(QUrl("qrc:/Samples/Maps/MapLoaded/MapLoaded.qml"));
view.show();
return app.exec();}