OpenStreetMap layer

View on GitHubSample viewer app

Add OpenStreetMap as a basemap layer.

screenshot

Use case

OpenStreetMap is a free community-edited basemap.

How to use the sample

When the sample opens, it will automatically display the map with the OpenStreetMap basemap. Pan and zoom to observe the basemap.

How it works

  1. Create a basemap using BasemapStyle::OsmStandard.
  2. Create a map with that basemap.
  3. Show the map in a map view.

Relevant API

  • Basemap
  • Map
  • MapView
  • OpenStreetMapLayer

Additional information

The attribution text will be set to the required OpenStreetMap attribution automatically.

Apps that expect to make many requests to OpenStreetMap should consider using an alternative tile server via the WebTiledLayer class.

Esri now hosts an OpenStreetMap vector layer on ArcGIS Online that uses recent OpenStreetMap data in conjunction with a style matching the default OpenStreetMap style. This layer is not subject to the tile access restrictions that apply to tiles fetched from OpenStreetMap.org.

Tags

basemap, layers, map, open, OpenStreetMap, OSM, street

Sample Code

OSM_Layer.cppOSM_Layer.cppOSM_Layer.hOSM_Layer.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
// [WriteFile Name=OSM_Layer, Category=Layers]
// [Legal]
// Copyright 2017 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 "OSM_Layer.h"

#include "Map.h"
#include "MapQuickView.h"
#include "OpenStreetMapLayer.h"
#include "Basemap.h"
#include "LayerListModel.h"

using namespace Esri::ArcGISRuntime;

OSM_Layer::OSM_Layer(QQuickItem* parent /* = nullptr */):
  QQuickItem(parent)
{
}

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

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

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

  // Create a map
  m_map = new Map(this);

  // Create a new OpenStreetMapLayer and add it to the list of basemap layers
  OpenStreetMapLayer* osm = new OpenStreetMapLayer(this);
  m_map->basemap()->baseLayers()->append(osm);

  // Set map to map view
  m_mapView->setMap(m_map);
}

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