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 list of bookmarks: map.bookmarks.append(bookmark).
  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.

Relevant API

  • Bookmark
  • BookmarkListModel
  • Viewpoint

Tags

bookmark, extent, location, zoom

Sample Code

ManageBookmarks.qml
                                                                                                                                                                                                                                                         
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
// [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]

import QtQuick 2.6
import QtQuick.Controls 2.2
import QtQuick.Layouts 1.3
import Esri.ArcGISRuntime 100.12

Rectangle {
    id: rootRectangle
    width: 800
    height: 600

    // Create MapView that contains a Map
    MapView {
        id: mapView
        anchors.fill: parent

        Map {
            id: map
            // Set the initial basemap to Imagery with Labels
            Basemap {
                initStyle: Enums.BasemapStyleArcGISImagery
            }

            onLoadStatusChanged: {
                // Once the map is loaded, add in the initial bookmarks
                if (loadStatus === Enums.LoadStatusLoaded) {
                    createBookmark("Mysterious Desert Pattern", desertViewpoint);
                    createBookmark("Strange Symbol", symbolViewpoint);
                    createBookmark("Guitar Shaped Forest", guitarViewpoint);
                    createBookmark("Grand Prismatic Spring", springViewpoint);
                    bookmarks.currentIndex = 0;
                }
            }

            // helper function for creating bookmarks
            function createBookmark(bookmarkName,bookmarkViewpoint) {
                // create a bookmark object and assign the name and viewpoint
                const bookmark = ArcGISRuntimeEnvironment.createObject("Bookmark");
                bookmark.name = bookmarkName;
                bookmark.viewpoint = bookmarkViewpoint;
                // append the bookmark to the map's BookmarkListModel
                map.bookmarks.append(bookmark);
            }
        }

        // Create the add button so new bookmarks can be added
        Rectangle {
            id: addButton
            property bool pressed: false
            anchors {
                right: parent.right
                bottom: mapView.attributionTop
                rightMargin: 20
                bottomMargin: 20
            }
            width: childrenRect.width
            height: childrenRect.height
            color: pressed ? "#959595" : "#D6D6D6"
            radius: 100
            border {
                color: "#585858"
                width: 1
            }

            Image {
                rotation: 45
                width: 32
                height: width
                source: "qrc:/Samples/Maps/ManageBookmarks/add.png"
            }

            MouseArea {
                anchors.fill: parent
                onPressed: addButton.pressed = true
                onReleased: addButton.pressed = false
                onClicked: {
                    // Show the add window when it is clicked
                    addWindow.visible = true;
                }
            }
        }
    }

    // Create Viewpoints for the 4 initial bookmarks
    ViewpointExtent {
        id: desertViewpoint
        extent: Envelope {
            xMin: 3742993.127298778
            xMax: 3744795.1333054285
            yMin: 3170396.4675719286
            yMax: 3171745.88077
            spatialReference: SpatialReference { wkid: 102100 }
        }
    }

    ViewpointExtent {
        id: symbolViewpoint
        extent: Envelope {
            xMin: -13009913.860076642
            xMax: -13009442.089218518
            yMin: 4495026.9307899885
            yMax: 4495404.031910696
            spatialReference: SpatialReference { wkid: 102100 }
        }
    }

    ViewpointExtent {
        id: guitarViewpoint
        extent: Envelope {
            xMin: -7124497.45137465
            xMax: -7121131.417429369
            yMin: -4012221.6124684606
            yMax: -4009697.0870095
            spatialReference: SpatialReference { wkid: 102100 }
        }
    }

    ViewpointExtent {
        id: springViewpoint
        extent: Envelope {
            xMin: -12338668.348591767
            xMax: -12338247.594362013
            yMin: 5546908.424239618
            yMax: 5547223.989911933
            spatialReference: SpatialReference { wkid: 102100 }
        }
    }

    // Create a combo box that allows for switching between bookmarks
    ComboBox {
        id: bookmarks
        anchors {
            left: parent.left
            top: parent.top
            margins: 5
        }

        property int modelWidth: 0
        width: modelWidth + rightPadding + leftPadding + indicator.width
        model: map.bookmarks

        Connections {
            target: bookmarks.model
            function onCountChanged() {
                const model = bookmarks.model;
                if (model) {
                    for (let i = 0; i < model.count; ++i) {
                        metrics.text = model.get(i).name;
                        bookmarks.modelWidth = Math.max(bookmarks.modelWidth,
                                                        metrics.width);
                    }
                }
            }
        }

        onCurrentIndexChanged: {
            if (currentIndex >= 0) {
                const bookmark = map.bookmarks.get(currentIndex);
                if (bookmark) {
                    mapView.setViewpoint(
                                map.bookmarks.get(currentIndex).viewpoint);
                }
            }
        }

        TextMetrics {
            id: metrics
            font: bookmarks.font
        }
    }

    // Create a window so names for new bookmarks can be specified
    Rectangle {
        id: addWindow
        anchors.centerIn: parent
        width: childrenRect.width
        height: childrenRect.height
        visible: false
        enabled: visible
        color: "lightgrey"
        opacity: .9
        radius: 5
        border {
            color: "#4D4D4D"
            width: 1
        }

        MouseArea {
            anchors.fill: parent
            onClicked: mouse.accepted = true;
        }

        GridLayout {
            columns: 2
            Text {
                text: qsTr("Provide the bookmark name")
                font.pixelSize: 12
                Layout.columnSpan: 2
                Layout.margins: 5
            }

            TextField {
                id: textField
                placeholderText: qsTr("ex: Grand Canyon")
                selectByMouse: true
                Layout.columnSpan: 2
                Layout.margins: 5
                Layout.fillWidth: true
            }


            Button {
                text: "Cancel"
                onClicked: addWindow.visible = false;
                Layout.margins: 5
            }

            Button {
                text: qsTr("Done")
                Layout.margins: 5
                Layout.alignment: Qt.AlignRight
                onClicked: {
                    // Create the new bookmark by getting the current viewpoint and using the
                    // user's input bookmark name
                    const viewpoint = mapView.currentViewpointExtent;
                    map.createBookmark(textField.text,viewpoint);
                    bookmarks.currentIndex = map.bookmarks.count -1;
                    textField.text = "";
                    addWindow.visible = false;
                }
            }
        }
    }
}

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