MbTilesDataProvider Class

A data provider that loads vector tiles from a MbTiles database.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v20.2.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public class MbTilesDataProvider :
    VectorTileDataProviderBase

VB.NET

Public Class MbTilesDataProvider
    Inherits VectorTileDataProviderBase

Remarks

A set of tiles can be packaged in MbTiles files (wrapped SQLite databases) stored locally or on a server. MbTiles can also contain raster tiles.

Follow the steps below to load data from a MbTiles file:

1. Install the System.Data.SQLite.Core package if your application does not reference this library.
2. Create an image layer and add it to the MapControl.Layers collection.
3. Create an MbTilesDataProvider instance and assign it to the ImageLayer.DataProvider property.
4. Use the MbTilesDataProvider.FileUri property to specify a path to an MbTiles file.

C#

private void Form1_Load(object sender, EventArgs e) {
    ImageLayer layer = new ImageLayer();
    MbTilesDataProvider dataProvider = new MbTilesDataProvider();
    dataProvider.FileUri = new Uri(@"D:\countries.mbtiles", UriKind.Absolute);
    layer.DataProvider = dataProvider;
    mapControl1.Layers.Add(layer);
}            

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim layer As ImageLayer = New ImageLayer()
    Dim dataProvider As MbTilesDataProvider = New MbTilesDataProvider()
    dataProvider.FileUri = New Uri("D:\countries.mbtiles", UriKind.Absolute)
    layer.DataProvider = dataProvider
    mapControl1.Layers.Add(layer)
End Sub

Apply a Custom Style

If a default vector tile style does not meet your requirements, you can apply a custom style. Use the VectorTileDataProviderBase.StyleFileUri property to define a path to a style file. See Vector Tile Providers: Vector Tile Styles for more information about styles.

C#

dataProvider.StyleFileUri = new Uri(@"D:\style.json", UriKind.Absolute);

VB.NET

dataProvider.StyleFileUri = New Uri("D:\style.json", UriKind.Absolute)

Inheritance

Object

MapDisposableObject

MapImageDataProviderBase

MapTileDataProviderBase

ImageTileDataProvider

VectorTileDataProviderBase

MbTilesDataProvider