Display overview map

View in

C++

QML

View on GitHub

Sample viewer app

Include an overview or inset map as an additional map view to show the wider context of the primary view.

screenshot

Use case

An overview map provides a useful, smaller-scale overview of the current map view's location. For example, when you need to inspect a layer with many features while remaining aware of the wider context of the view, use an overview map to help show the extent of the main map view.

How to use the sample

Pan or zoom across the map view to browse through the tourist attractions feature layer and watch the viewpoint or scale of the linked overview map update automatically. You can also navigate by panning and zooming on the overview map directly.

How it works

Create a Map with the ArcGISTopographic basemap style and add it to the MapView.
Instantiate a FeatureLayer from a ServiceFeatureTable and append it to the Map's operational layers.
In the user-interface, declare an OverviewMap object from the ArcGIS Runtime Toolkit.
Assign the MapView to the geoView property of the OverviewMap to connect the MapView with the OverviewMap.

Relevant API

MapView
OverviewMap

About the data

The data used in this sample is the OpenStreetMap Tourist Attractions for North America feature layer, which is scale-dependent and displays at scales larger than 1:160,000.

Additional information

This sample uses the overview map toolkit component, which requires the toolkit to be cloned and set up locally. For information about setting up the toolkit, visit the repository's UI Tools page.

Sample Code

DisplayOverviewMap.cpp

DisplayOverviewMap.h

DisplayOverviewMap.qml

Use dark colors for code blocksCopy
// [WriteFile Name=DisplayOverviewMap, Category=Maps]
// [Legal]
// Copyright 2021 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

#include "DisplayOverviewMap.h"

#include "FeatureLayer.h"
#include "Map.h"
#include "MapQuickView.h"
#include "ServiceFeatureTable.h"
#include "Viewpoint.h"

using namespace Esri::ArcGISRuntime;

DisplayOverviewMap::DisplayOverviewMap(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(new Basemap(BasemapStyle::ArcGISTopographic, this), this))
{
  m_map->setInitialViewpoint(Viewpoint(49.28299, -123.12052, 70000));

  // Access the feature layer and add it to the maps operational layers.
  ServiceFeatureTable* serviceFeatureTable = new ServiceFeatureTable(QUrl("https://services6.arcgis.com/Do88DoK2xjTUCXd1/arcgis/rest/services/OSM_Tourism_NA/FeatureServer/0"), this);
  serviceFeatureTable->setFeatureRequestMode(FeatureRequestMode::OnInteractionCache);
  FeatureLayer* featureLayer = new FeatureLayer(serviceFeatureTable, this);
  m_map->operationalLayers()->append(featureLayer);
}

DisplayOverviewMap::~DisplayOverviewMap() = default;

void DisplayOverviewMap::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<DisplayOverviewMap>("Esri.Samples", 1, 0, "DisplayOverviewMapSample");
}

MapQuickView* DisplayOverviewMap::mapView() const
{
  return m_mapView;
}

// Set the view (created in QML)
void DisplayOverviewMap::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
    return;

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  emit mapViewChanged();
}