OpenStreetMapDataProvider.TileUriTemplate Property
Gets or sets a template that is used to obtain image tiles from the current OpenStreetMap provider.
Namespace: DevExpress.XtraMap
Assembly: DevExpress.XtraMap.v19.2.dll
Declaration
Property Value
Type | Description |
---|---|
String | A String that contains the template Uri. |
Remarks
Important
Use of this property assumes that an OSM Tile Server is used. This means that all tiles for all zoom levels can be loaded. In a case when not all tiles are available, design a custom tile provider.
Use the following pattern to specify TemplateUriTemplate: https://{0}.tile.INSERT_SERVER_NAME.com/{1}/{2}/{3}.png
Template placeholders will be replaced with the following values on a tile request.
- {0} - A sub-domain of the OSM server.
- {1} - The current zoom level.
- {2} - The horizontal (X) index of the requested tile.
- {3} - The vertical (Y) index of the requested tile.
Note
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 specific values for the OpenStreetMapDataProvider.TileUriTemplate property. Note that by default, this property is set to obtain data from the OpenStreetMap official web service.
Note that if the TileUriTemplate property contains an invalid URI, the layer to which the provider is assigned raises the LayerBase.Error event.
Example
This example uses OpenStreetMapDataProvider to connect Map Control to the OpenStreetMap service.
Follow the steps below to display the OpenStreetMap geodata in the Map Control:
Use the ServicePointManager.SecurityProtocol property to specify the network security protocol before the InitializeComponent method call.
Create a MapControl object. Set the MapControl.Dock property to the DockStyle.Fill value to fit the Map Control to the form. Call the Add method to add the Map Control to the form’s control collection.
Create ImageLayer and use the MapControl.Layers.Add method to add this layer to the map.
Create an OpenStreetMapDataProvider object and assign it to the ImageLayer.DataProvider property. Specify the
OpenStreetMapDataProvider.TileUriTemplate
property to load data from an OSM server. Our example contains a sample template string that does not connect to an existing OSM server.Handle the OpenStreetMapDataProvider.WebRequest event and use the e.UserAgent property to pass the user-agent HTTP header to the server.
Note
Specify a valid OSM server name in the OpenStreetMapDataProvider.TileUriTemplate
property. For instance, you can set your own tile server, use a public OSM server or choose alternative OSM servers. For more information, refer to the following article: Tile Usage Policy.
using System;
using System.Windows.Forms;
using DevExpress.XtraEditors;
using DevExpress.XtraMap;
namespace ConnectToOpenStreet {
public partial class Form1 : Form {
public Form1() {
// Specify the network security protocol.
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
InitializeComponent();
}
private void Form1_Load(object sender, EventArgs e) {
// Create a Map Control.
MapControl map = new MapControl();
// Specify the map position on the form.
map.Dock = DockStyle.Fill;
// Add the Map Control to the form.
this.Controls.Add(map);
// Create an image tiles layer and add it to the map.
ImageLayer tileLayer = new ImageLayer();
map.Layers.Add(tileLayer);
// Create an Open Street Map data provider.
OpenStreetMapDataProvider provider = new OpenStreetMapDataProvider();
tileLayer.DataProvider = provider;
// Specify the TileUriTemplate property to connect the Map Control to an OSM server.
provider.TileUriTemplate = "http://{0}.tile.MyCustomOSMProvider.org/{1}/{2}/{3}.png";
provider.WebRequest += OnWebRequest;
}
// Pass the user-agent HTTP header to the OSM server.
private void OnWebRequest(object sender, MapWebRequestEventArgs e) {
e.UserAgent = "XtraMap Getting Started - Connect to OpenStreetMap";
}
}
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TileUriTemplate property.
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.