Manage bookmarks

View inQMLC++
View on GitHub
Sample viewer app

Access and create bookmarks on a map.

screenshot

Use case

Bookmarks are used for easily storing and accessing saved locations on the map. Bookmarks are of interest in educational apps (e.g. touring historical sites) or more specifically, for a land management company wishing to visually monitor flood levels over time at a particular location. These locations can be saved as bookmarks and revisited easily each time their basemap data has been updated (e.g. working with up to date satellite imagery to monitor water levels).

How to use the sample

The map in the sample comes pre-populated with a set of bookmarks. To access a bookmark and move to that location, click on a bookmark's name from the list. To add a bookmark, pan and/or zoom to a new location and click on the '+' in the bottom corner. Enter a unique name for the bookmark and click ok, and the bookmark will be added to the list

How it works

  1. Create a new Map object and create a BookmarkList with Map::bookmarks().
  2. To create a new bookmark and add it to the bookmark list:
    • Create a new Bookmark object passing in text (the name of the bookmark) and a Viewpoint as parameters.
    • Add the new bookmark to the book mark list with BookmarkListModel::append(bookmark).

Relevant API

  • Bookmark
  • BookmarkListModel
  • Viewpoint

Tags

bookmark, extent, location, zoom

Sample Code

ManageBookmarks.cppManageBookmarks.cppManageBookmarks.hManageBookmarks.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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
// [WriteFile Name=ManageBookmarks, 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

#include "ManageBookmarks.h"

#include "Map.h"
#include "MapQuickView.h"
#include "Basemap.h"
#include "SpatialReference.h"
#include "Envelope.h"
#include "Viewpoint.h"
#include "Bookmark.h"

using namespace Esri::ArcGISRuntime;

ManageBookmarks::ManageBookmarks(QQuickItem* parent) :
  QQuickItem(parent)
{
}

ManageBookmarks::~ManageBookmarks() = default;

void ManageBookmarks::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<ManageBookmarks>("Esri.Samples", 1, 0, "ManageBookmarksSample");
  qmlRegisterUncreatableType<QAbstractListModel>("Esri.Samples", 1, 0, "AbstractListModel", "AbstractListModel is uncreateable");
}

void ManageBookmarks::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");

  // create a new basemap instance
  Basemap* basemap = new Basemap(BasemapStyle::ArcGISImagery, this);
  // create a new map instance
  m_map = new Map(basemap, this);
  // set map on the map view
  m_mapView->setMap(m_map);

  // create the bookmarks once the map is loaded
  connect(m_map, &Esri::ArcGISRuntime::Map::loadStatusChanged, this, [this](Esri::ArcGISRuntime::LoadStatus loadStatus)
  {
    if (loadStatus == LoadStatus::Loaded)
    {
      m_bookmarks = m_map->bookmarks();
      createInitialBookmarks();
    }
  });
}

void ManageBookmarks::createInitialBookmarks()
{
  // Mysterious Desert Pattern
  Envelope env1(3742993.127298778, 3170396.4675719286, 3744795.1333054285, 3171745.88077, SpatialReference(102100));
  Viewpoint viewpoint1(env1);
  createBookmark("Mysterious Desert Pattern", viewpoint1);

  // Strange Symbol
  Envelope env2(-13009913.860076642, 4495026.9307899885, -13009442.089218518, 4495404.031910696, SpatialReference(102100));
  Viewpoint viewpoint2(env2);
  createBookmark("Strange Symbol", viewpoint2);

  // Guitar-Shaped Forest
  Envelope env3(-7124497.45137465, -4012221.6124684606, -7121131.417429369, -4009697.0870095, SpatialReference(102100));
  Viewpoint viewpoint3(env3);
  createBookmark("Guitar-Shaped Forest", viewpoint3);

  // Grand Prismatic Spring
  Envelope env4(-12338668.348591767, 5546908.424239618, -12338247.594362013, 5547223.989911933, SpatialReference(102100));
  Viewpoint viewpoint4(env4);
  createBookmark("Grand Prismatic Spring", viewpoint4);
}

void ManageBookmarks::createBookmark(QString name, Viewpoint viewpoint)
{
  //! [Add bookmarks to the list model]
  // Get the bookmark list
  BookmarkListModel* bookmarks = dynamic_cast<BookmarkListModel*>(m_bookmarks);
  if (!bookmarks)
    return;

  // Create the bookmark from the name and viewpoint
  Bookmark* bookmark = new Bookmark(name, viewpoint, this);

  // Add it to the map's bookmark list
  bookmarks->append(bookmark);

  // emit that model has changed
  emit bookmarksChanged();
  //! [Add bookmarks to the list model]
}

void ManageBookmarks::goToBookmark(int bookmarkIndex)
{
  BookmarkListModel* bookmarks = dynamic_cast<BookmarkListModel*>(m_bookmarks);
  if (!bookmarks)
    return;

  m_mapView->setViewpoint(bookmarks->at(bookmarkIndex)->viewpoint());
}

QAbstractListModel* ManageBookmarks::bookmarks() const
{
  return m_bookmarks;
}

void ManageBookmarks::addBookmark(QString newBookmarkName)
{
  createBookmark(newBookmarkName, m_mapView->currentViewpoint(ViewpointType::BoundingGeometry));
}

QString ManageBookmarks::bookmarkNameForIndex(int index) const
{
  return m_bookmarks->data(m_bookmarks->index(index),
                           BookmarkListModel::BookmarkNameRole).toString();
}

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