Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for Qt

Manage bookmarks

Sample Viewer View Sample on GitHub

Access and create bookmarks on a map.

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

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

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
            BasemapImageryWithLabels {}

            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;
                }
            }
        }
    }
}