Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for .NET

OpenStreetMap layer

This code sample is available for these platforms:
View Sample on GitHub

Add OpenStreetMap as a basemap layer.

Image of OpenStreetMap layer

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 with the static method Basemap.CreateOpenStreetMap
  2. Create a map with that basemap.
  3. Show the map in a map view.

Relevant API

  • Basemap
  • Basemap.CreateOpenStreetMap
  • 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. See layer types described in the ArcGIS Runtime SDK for .NET documentation for more information on OpenStreetMap usage restrictions and alternatives.

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

<?xml version="1.0" encoding="utf-8"?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:esriUI="clr-namespace:Esri.ArcGISRuntime.Xamarin.Forms;assembly=Esri.ArcGISRuntime.Xamarin.Forms"
             x:Class="ArcGISRuntimeXamarin.Samples.OpenStreetMapLayer.OpenStreetMapLayer">
    <Grid>
        <esriUI:MapView x:Name="MyMapView" />
    </Grid>
</ContentPage>
// Copyright 2019 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.

using Esri.ArcGISRuntime.Mapping;
using Xamarin.Forms;

namespace ArcGISRuntimeXamarin.Samples.OpenStreetMapLayer
{
    [ArcGISRuntime.Samples.Shared.Attributes.Sample(
        name: "OpenStreetMap layer",
        category: "Layers",
        description: "Add OpenStreetMap as a basemap layer.",
        instructions: "When the sample opens, it will automatically display the map with the OpenStreetMap basemap. Pan and zoom to observe the basemap.",
        tags: new[] { "OSM", "OpenStreetMap", "basemap", "layers", "map", "open", "street" })]
    public partial class OpenStreetMapLayer : ContentPage
    {
        public OpenStreetMapLayer()
        {
            InitializeComponent();
            Initialize();
        }

        private void Initialize()
        {
            // Create the OpenStreetMap basemap.
            Basemap osmBasemap = Basemap.CreateOpenStreetMap();

            // Create the map with the OpenStreetMap basemap.
            Map osmMap = new Map(osmBasemap);

            // Show the map in the view.
            MyMapView.Map = osmMap;
        }
    }
}