Get the draw status of your map view or scene view to know when all layers in the map or scene have finished drawing.

Use case
You may want to display a loading indicator while layers are loading.
How it works
- Create a
MapViewand connect to theMapQuickView::drawStatusChangedsignal. - Use
drawStatuson the to determine draw status.
Relevant API
- Map
- drawStatus
- MapQuickView::drawStatusChanged
- MapView
Tags
draw, loading, map, render
Sample Code
// [WriteFile Name=DisplayDrawingStatus, 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 "DisplayDrawingStatus.h"
// ArcGIS Maps SDK headers#include "Envelope.h"#include "FeatureLayer.h"#include "LayerListModel.h"#include "Map.h"#include "MapQuickView.h"#include "MapTypes.h"#include "MapViewTypes.h"#include "ServiceFeatureTable.h"#include "SpatialReference.h"#include "Viewpoint.h"
// Qt headers#include <QUrl>
using namespace Esri::ArcGISRuntime;
DisplayDrawingStatus::DisplayDrawingStatus(QQuickItem* parent): QQuickItem(parent){}
DisplayDrawingStatus::~DisplayDrawingStatus() = default;
void DisplayDrawingStatus::init(){ qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView"); qmlRegisterType<DisplayDrawingStatus>("Esri.Samples", 1, 0, "DisplayDrawingStatusSample");}
void DisplayDrawingStatus::componentComplete(){ QQuickItem::componentComplete();
// find QML MapView component m_mapView = findChild<MapQuickView*>("mapView"); m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);
// Create a map using the topographic basemap m_map = new Map(BasemapStyle::ArcGISTopographic, this); m_map->setInitialViewpoint(Viewpoint(Envelope(-13639984, 4537387, -13606734, 4558866, SpatialReference::webMercator())));
// create feature layer ServiceFeatureTable* featureTable = new ServiceFeatureTable(QUrl("https://sampleserver6.arcgisonline.com/arcgis/rest/services/DamageAssessment/FeatureServer/0"), this); m_featureLayer = new FeatureLayer(featureTable, this);
// add the layer to the map m_map->operationalLayers()->append(m_featureLayer);
// Set map to map view m_mapView->setMap(m_map);
connect(m_mapView, &MapQuickView::drawStatusChanged, this, [this](DrawStatus drawStatus) { m_mapDrawing = (drawStatus == DrawStatus::InProgress); emit mapDrawStatusChanged(); });}
bool DisplayDrawingStatus::mapDrawing() const{ return m_mapDrawing;}// [WriteFile Name=DisplayDrawingStatus, 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 DISPLAYDRAWINGSTATUS_H#define DISPLAYDRAWINGSTATUS_H
// Qt headers#include <QQuickItem>
namespace Esri::ArcGISRuntime{ class Map; class MapQuickView; class FeatureLayer;}
class DisplayDrawingStatus : public QQuickItem{ Q_OBJECT
Q_PROPERTY(bool mapDrawing READ mapDrawing NOTIFY mapDrawStatusChanged)
public: explicit DisplayDrawingStatus(QQuickItem* parent = nullptr); ~DisplayDrawingStatus() override;
void componentComplete() override; static void init();
signals: void mapDrawStatusChanged();
private: bool mapDrawing() const;
private: Esri::ArcGISRuntime::Map* m_map = nullptr; Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr; Esri::ArcGISRuntime::FeatureLayer* m_featureLayer = nullptr; bool m_mapDrawing = false;};
#endif // DISPLAYDRAWINGSTATUS_H// [WriteFile Name=DisplayDrawingStatus, 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 QtQuick.Controlsimport Esri.Samples
DisplayDrawingStatusSample { id: displayDrawingStatusSample clip: true 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(); } }
// dim window if map is drawing Rectangle { anchors.fill: parent color: "transparent" visible: displayDrawingStatusSample.mapDrawing
Rectangle { anchors.fill: parent color: "#60000000" }
// pop up to show if MapView is drawing Rectangle { anchors.centerIn: parent width: 100 height: 100 radius: 3 opacity: 0.85 color: "#E0E0E0" border.color: "black"
Column { anchors { centerIn: parent topMargin: 5 } spacing: 5
BusyIndicator { anchors.horizontalCenter: parent.horizontalCenter height: 60 running: displayDrawingStatusSample.mapDrawing }
Text { anchors.horizontalCenter: parent.horizontalCenter font { weight: Font.Black pixelSize: 12 } height: 20 horizontalAlignment: Text.AlignHCenter text: "Drawing..." } } } }}// [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 "DisplayDrawingStatus.h"
// ArcGIS Maps SDK headers#include "ArcGISRuntimeEnvironment.h"
// Qt headers#include <QCommandLineParser>#include <QDir>#include <QGuiApplication>#include <QQmlEngine>#include <QQuickView>
// 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("DisplayDrawingStatus"));
// 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 DisplayDrawingStatus::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/DisplayDrawingStatus/DisplayDrawingStatus.qml"));
view.show();
return app.exec();}