Image Tile Providers
- 6 minutes to read
A MapControl uses image tile data providers to provide map image layers with data from imagery services. Specify the ImageLayer.DataProvider property to add tiles from imagery services to the map.
The Map control supports the following tile providers:
Create a data provider to use another online imagery service or load image tiles from an intranet server.
You can also generate tiles from an image tile source at runtime.
Azure Maps Data Provider
This data provider loads image tiles from Microsoft Azure Maps.
Note
You should register an Azure Maps key to use the Azure Maps services. Refer to the following help topic for additional information: Create an Azure Maps Account.
Use the following API members to connect the Map Control to the Azure Maps service:
Member | Description |
---|---|
ImageLayer | Displays map images obtained from the map image data provider. |
ImageLayer.DataProvider | Gets or sets the provider used to obtain images from an image source. |
AzureMapDataProvider | Loads map images from the Azure Maps data provider. |
AzureMapDataProvider.AzureKey | Specifies the key you receive when you create an Azure Maps account. |
You can also specify the following settings for a map layer:
Member | Description |
---|---|
CultureName | Gets or sets the Culture name used to obtain data from Azure GIS services. |
LocalizedView | Specifies the map view for a certain country/region. |
Tileset | Specifies the tileset that the provider loads from the service. |
Projection | Gets a projection used by the Azure Maps data provider. |
The following example connects to Azure Maps and specifies map layers:
<dxm:MapControl>
<dxm:ImageLayer>
<dxm:AzureMapDataProvider Tileset="Imagery" AzureKey="your key"/>
</dxm:ImageLayer>
<dxm:ImageLayer>
<dxm:AzureMapDataProvider Tileset="BaseLabelsRoad" AzureKey="your key"/>
</dxm:ImageLayer>
</dxm:MapControl>
OpenStreetMap Data Provider
This data provider loads image tiles from the the OpenStreetMap service.
Note
Review the Copyright and License and Tile usage policy pages before using map images in the OpenStreetMap format.
You should provide the UserAgent parameter with a valid value to identify your application.
Use the OpenStreetMapDataProvider class to work with OpenStreetMap:
<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>
Use the following API members to connect the Map Control to the OpenStreetMap service:
Member | Description |
---|---|
ImageLayer | Displays map images obtained from the map image data provider. |
ImageLayer.DataProvider | Gets or sets the provider used to obtain images from an image source. |
OpenStreetMapDataProvider | The class that loads map images from a web resource that provides data in the OpenStreetMap format. |
MapImageDataProviderBase.WebRequest | Occurs when the Map control sends a request to a web service. |
OpenStreetMapDataProvider.TileUriTemplate | Gets or sets a template that is used to obtain image tiles from the current OpenStreetMap provider. |
MapWebRequestEventArgs.UserAgent | Gets or sets the value of the user-agent HTTP header. |
The Map Control also supports the following OpenStreetMap data providers:
Bing Maps Data Provider
Important
On May 21, 2024, Microsoft announced that Bing Maps for Enterprise and its API will be discontinued. Azure Maps will be a single unified enterprise mapping platform available from Microsoft.
To obtain and display map data from Azure Maps, we implemented the following providers:
- AzureMapDataProvider
- AzureSearchDataProvider
- AzureRouteDataProvider
- AzureGeocodeDataProvider
- AzureTrafficIncidentDataProvider
- AzureRouteIsochroneDataProvider
For information on how to migrate your app from Bing Maps to Azure Maps, see the following help topic: DevExpress Map Control for WPF: Migrate from Bing Maps to Azure Maps.
If you already have a Bing Maps for Enterprise license, you can keep using the current API. You must transition to the new API by June 30, 2025 (for free/basic licenses) or June 30, 2028 (for enterprise licenses). New licenses will no longer be available after June 30, 2025. Bing Maps will not work with our map controls without a license after that date.
Generate Tiles at Runtime
Perform the following steps to populate a map with custom tiles created at runtime:
- Create an ImageTileDataProvider object and assign it to the ImageLayer.DataProvider property.
- Create a class that inherits the ImageTileSource class.
- Implement the ImageTileSource.GetImageSource method that returns a bitmap for each tile based on its indices and the map control’s zoom level.
- Assign an instance of the class you developed to the ImageTileDataProvider.TileSource property.
<Window
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:local="clr-namespace:DXMapInMemoryTileProvider"
xmlns:dxm="http://schemas.devexpress.com/winfx/2008/xaml/map"
x:Class="DXMapInMemoryTileProvider.MainWindow"
mc:Ignorable="d"
Title="MainWindow" Height="450" Width="800">
<Grid>
<dxm:MapControl>
<dxm:ImageLayer x:Name="imageLayer"/>
</dxm:MapControl>
</Grid>
</Window>
The Map Control stores the loaded tiles in cache. To customize cache parameters, use the MapControl.CacheOptions property.
Custom Image Data Provider
To develop a data provider, create a MapDataProviderBase class descendant and define a custom image tile source for it. This image tile source should be derived from MapTileSourceBase and provide a way to retrieve image tiles.