Open mobile map (map package)

View inQMLC++
View on GitHub
Sample viewer app

Display a map from a mobile map package.

screenshot

Use case

An .mmpk file is an archive containing the data (specifically, basemaps and features) used to display an offline map.

How to use the sample

When the sample opens, it will automatically display the map in the mobile map package. Pan and zoom to observe the data from the mobile map package.

How it works

  1. Create a MobileMapPackage specifying the path to the .mmpk file.
  2. Load the mobile map package with mmpk::load().
  3. After it successfully loads, get the map from the .mmpk and add it to the map view: mapView::setMap(mmpk::maps()::at(0)).

Relevant API

  • MapView
  • MobileMapPackage

Offline Data

Read more about how to set up the sample's offline data here.

Link Local Location
Yellowstone Mobile Map Package <userhome>/ArcGIS/Runtime/Data/mmpk/Yellowstone.mmpk

Tags

mmpk, mobile map package, offline

Sample Code

OpenMobileMap_MapPackage.cppOpenMobileMap_MapPackage.cppOpenMobileMap_MapPackage.hOpenMobileMap_MapPackage.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
// [WriteFile Name=OpenMobileMap_MapPackage, 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 "OpenMobileMap_MapPackage.h"

#include "Basemap.h"
#include "Error.h"
#include "MapQuickView.h"
#include "MobileMapPackage.h"

#include <QDir>
#include <QtCore/qglobal.h>

#ifdef Q_OS_IOS
#include <QStandardPaths>
#endif // Q_OS_IOS

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
QString defaultDataPath()
{
  QString dataPath;

#ifdef Q_OS_ANDROID
  dataPath = "/sdcard";
#elif defined Q_OS_IOS
  dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
#else
  dataPath = QDir::homePath();
#endif

  return dataPath;
}

// sample MMPK location
const QString sampleFileYellowstone {"/ArcGIS/Runtime/Data/mmpk/Yellowstone.mmpk"};

} // namespace

OpenMobileMap_MapPackage::OpenMobileMap_MapPackage(QQuickItem* parent) :
  QQuickItem(parent)
{
  // connect to the Mobile Map Package instance to know when errors occur
  connect(MobileMapPackage::instance(), &MobileMapPackage::errorOccurred,
          [](Error e)
  {
    if (e.isEmpty())
    {
      return;
    }

    qDebug() << QString("Error: %1 %2").arg(e.message(), e.additionalMessage());
  });
}

OpenMobileMap_MapPackage::~OpenMobileMap_MapPackage() = default;

void OpenMobileMap_MapPackage::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<OpenMobileMap_MapPackage>("Esri.Samples", 1, 0, "OpenMobileMap_MapPackageSample");
}

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

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

  // create the MMPK data path
  // data is downloaded automatically by the sample viewer app. Instructions to download
  // separately are specified in the readme.
  const QString dataPath = defaultDataPath() + sampleFileYellowstone;

  // Load the MMPK
  createMapPackage(dataPath);
}

// create map package
void OpenMobileMap_MapPackage::createMapPackage(const QString& path)
{
  //! [open mobile map package cpp snippet]
  // instatiate a mobile map package
  m_mobileMapPackage = new MobileMapPackage(path, this);

  // wait for the mobile map package to load
  connect(m_mobileMapPackage, &MobileMapPackage::doneLoading, this, [this](Error error)
  {
    if (!error.isEmpty())
    {
      qDebug() << QString("Package load error: %1 %2").arg(error.message(), error.additionalMessage());
      return;
    }

    if (!m_mobileMapPackage || !m_mapView || m_mobileMapPackage->maps().isEmpty())
    {
      return;
    }

    // The package contains a list of maps that could be shown in the UI for selection.
    // For simplicity, obtain the first map in the list of maps.
    // set the map on the map view to display
    m_mapView->setMap(m_mobileMapPackage->maps().at(0));

  });

  m_mobileMapPackage->load();
  //! [open mobile map package cpp snippet]
}

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