Map loaded

View on GitHubSample viewer app

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

screenshot

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

  1. Create a Map and add it to a MapView.
  2. Connect to the Map::loadStatusChanged signal to query the map's load status. The LoadStatus is LoadStatus::Loaded when 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

MapLoaded.cppMapLoaded.cppMapLoaded.hMapLoaded.qml
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
// [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;
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.