OpenStreetMapDataProvider Class

The class that loads map images from a web resource that provides data in the OpenStreetMap format.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class OpenStreetMapDataProvider :
    MapDataProviderBase,
    IOpenStreetMapKindProvider

VB.NET

Public Class OpenStreetMapDataProvider
    Inherits MapDataProviderBase
    Implements IOpenStreetMapKindProvider

Remarks

Before using map images in the OpenStreetMap format, please review the Copyright and License and Tile usage policy pages. To control which web resource should be used in your application as an OpenStreetMap data provider, you should assign a specific value for the OpenStreetMapDataProvider.TileUriTemplate property.

Example

This example demonstrates how to connect to the OpenStreetMap using the OpenStreetMapDataProvider object.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/xtramap-getting-started-lesson-2-connect-to-openstreetmap-e5070

MainForm.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraEditors;
using DevExpress.XtraMap;

namespace ConnectToOpenStreet {
    public partial class MainForm : XtraForm {
        public MainForm() {
            InitializeComponent();
        }

        #region #CreateOSMLayer
        private void Form1_Load(object sender, EventArgs e) {
            // Create an image layer and add it to the map.
            mapControl.Layers.Add(new ImageLayer() {
                // Create an OpenStreetMap data provider and assign it to the layer.
                DataProvider = new OpenStreetMapDataProvider()
            });
        }
        #endregion #CreateOSMLayer
    }
}

MainForm.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraEditors
Imports DevExpress.XtraMap

Namespace ConnectToOpenStreet
    Partial Public Class MainForm
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
        End Sub

        #Region "#CreateOSMLayer"
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
            ' Create an image layer and add it to the map.
            mapControl.Layers.Add(New ImageLayer() With {.DataProvider = New OpenStreetMapDataProvider()})
                ' Create an OpenStreetMap data provider and assign it to the layer.
        End Sub
        #End Region ' #CreateOSMLayer
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the OpenStreetMapDataProvider class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-cache-image-tiles-locally-e5071/CS/CacheImageTiles/Form1.cs#L26

// Create an Open Street data provider.
OpenStreetMapDataProvider provider = new OpenStreetMapDataProvider();
tilesLayer.DataProvider = provider;

how-to-customize-the-appearance-of-a-map-shape-title-e5184/CS/CustomizeShapeTitle/Form1.cs#L28

ImageLayer tilesLayer = new ImageLayer() {
    DataProvider = new OpenStreetMapDataProvider()
};

how-to-programmatically-create-a-map-control-and-connect-it-to-the-openstreet-web-service-e4665/CS/CreateMap/Form1.cs#L23

// Create a data provider.
OpenStreetMapDataProvider provider = new OpenStreetMapDataProvider();
layer.DataProvider = provider;

xtramap-getting-started-lesson-2-connect-to-openstreetmap-e5070/CS/ConnectToOpenStreet/Form1.cs#L26

// Create an Open Street Map data provider.
OpenStreetMapDataProvider provider = new OpenStreetMapDataProvider();
tilesLayer.DataProvider = provider;

how-to-use-the-openstreetmap-geocode-service-via-the-map-control-t629683/CS/OsmGeocodeSample/MainForm.cs#L15

new ImageLayer {
    DataProvider = new OpenStreetMapDataProvider() {
        TileUriTemplate = "YOUR_TILE_SERVICE.com/{1}/{2}/{3}"

VB.NET

how-to-cache-image-tiles-locally-e5071/VB/CacheImageTiles/Form1.vb#L28

' Create an Open Street data provider.
Dim provider As New OpenStreetMapDataProvider()
tilesLayer.DataProvider = provider

how-to-customize-the-appearance-of-a-map-shape-title-e5184/VB/CustomizeShapeTitle/Form1.vb#L26

' Create a layer to load image tiles.
Dim tilesLayer As New ImageLayer() With {.DataProvider = New OpenStreetMapDataProvider()}
map.Layers.Add(tilesLayer)

how-to-programmatically-create-a-map-control-and-connect-it-to-the-openstreet-web-service-e4665/VB/CreateMap/Form1.vb#L25

' Create a data provider.
Dim provider As New OpenStreetMapDataProvider()
layer.DataProvider = provider

xtramap-getting-started-lesson-2-connect-to-openstreetmap-e5070/VB/ConnectToOpenStreet/Form1.vb#L28

' Create an Open Street data provider.
Dim provider As New OpenStreetMapDataProvider()
tilesLayer.DataProvider = provider

how-to-use-the-openstreetmap-geocode-service-via-the-map-control-t629683/VB/OsmGeocodeSample/MainForm.vb#L17

New ImageLayer With { _
    .DataProvider = New OpenStreetMapDataProvider() With {.TileUriTemplate = "YOUR_TILE_SERVICE.com/{1}/{2}/{3}"} _
}, _

Inheritance

Object

MapDisposableObject

MapImageDataProviderBase

MapDataProviderBase

OpenStreetMapDataProvider