OpenStreetMapDataProvider Class

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

Assembly: DevExpress.Xpf.Map.v24.1.dll

Declaration

C#
VB.NET

public class OpenStreetMapDataProvider :
    MapDataProviderBase

Public Class OpenStreetMapDataProvider
    Inherits MapDataProviderBase

Remarks

Before using map images in the OpenStreetMap format, please review the Copyright and License and Tile usage policy pages. To control which OpenStreetMap subdomains should be used, use the OpenStreetMapDataProvider.Subdomains property. The OpenStreetMapDataProvider.TileUriTemplate property allows specifying the OpenStreetMap data provider used to obtain tiles.

Example

Tip

A complete sample project is available in the DevExpress Code Examples database at https://supportcenter.devexpress.com/ticket/details/e3617/how-to-connect-to-openstreetmap.

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

<dxm:MapControl>
    <dxm:MapControl.Layers>
        <dxm:ImageLayer>
            <dxm:ImageLayer.DataProvider>
                <dxm:OpenStreetMapDataProvider TileUriTemplate="http://{subdomain}.tile.MyCustomOSMProvider.org/{tileLevel}/{tileX}/{tileY}.png"
                                               WebRequest="OnWebRequest"/>
            </dxm:ImageLayer.DataProvider>
        </dxm:ImageLayer>
    </dxm:MapControl.Layers>
</dxm:MapControl>

private void OnWebRequest(object sender, DevExpress.Xpf.Map.MapWebRequestEventArgs e) {
    e.UserAgent = "DevExpress OpenStreetMapProvider example";
}

Private Sub OnWebRequest(ByVal sender As Object, ByVal e As DevExpress.Xpf.Map.MapWebRequestEventArgs)
    e.UserAgent = "DevExpress OpenStreetMapProvider example"
End Sub

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

XAML

dxmap-getting-started-lesson-2-connect-to-openstreetmap-e3617/CS/MainWindow.xaml#L10

<dxm:ImageLayer.DataProvider>
    <dxm:OpenStreetMapDataProvider TileUriTemplate="http://{subdomain}.tile.MyCustomOSMProvider.org/{tileLevel}/{tileX}/{tileY}.png"
                                   WebRequest="OnWebRequest"/>