windowsforms-devexpress-dot-xtramap-b55660b8.md
The data adapter that provides the means to bind the Map control to data.
Namespace : DevExpress.XtraMap
Assembly : DevExpress.XtraMap.v25.2.dll
NuGet Package : DevExpress.Win.Map
[ListSourceDataAdapter.ListSourceBindingProperties]
public class ListSourceDataAdapter :
DataSourceAdapterBase,
IListSourceDataAdapter,
IDataSourceDataAdapter,
IDataAdapter,
IDisposable
<ListSourceDataAdapter.ListSourceBindingProperties>
Public Class ListSourceDataAdapter
Inherits DataSourceAdapterBase
Implements IListSourceDataAdapter,
IDataSourceDataAdapter,
IDataAdapter,
IDisposable
This example binds a Map control to data. This data is stored in an external XML file that contains information about wrecked ships, including ship coordinates.
In this example, the map control generates ship images based on data from the data source, along with a description for each image in a tooltip.
Follow the steps below to create a map as on the image above:
ListSourceDataAdapter object and assign it to the VectorItemsLayer.Data property.Also, this sample illustrates how to customize tooltips using the MapItemsLayerBase.ToolTipPattern property.
Note
For more information on how to add images on the map, refer to the following help topic: Generate Vector Items Automatically.
// In the Form's constructor.
object data = LoadData(@"..\..\Data\Ships.xml");
// Create a vector layer.
map.Layers.Add(new VectorItemsLayer() {
Data = CreateAdapter(data),
ToolTipPattern = "<b>{Name} ({Year})</b> \r\n{Description}",
ItemImageIndex = 0
});
// Creates an adapter for the map's vector layer.
private IMapDataAdapter CreateAdapter(object source) {
ListSourceDataAdapter adapter = new ListSourceDataAdapter();
adapter.DataSource = source;
adapter.Mappings.Latitude = "Latitude";
adapter.Mappings.Longitude = "Longitude";
adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Name", Name = "Name" });
adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Year", Name = "Year" });
adapter.AttributeMappings.Add(new MapItemAttributeMapping() { Member = "Description", Name = "Description" });
return adapter;
}
// Loads data from a XML file.
private List<ShipwreckData> LoadData(string path) {
return XDocument.Load(path).Element("Ships").Elements("Ship")
.Select(e => new ShipwreckData(
year: Convert.ToInt32(e.Element("Year").Value, CultureInfo.InvariantCulture),
name: e.Element("Name").Value,
description: e.Element("Description").Value,
latitude: Convert.ToDouble(e.Element("Latitude").Value, CultureInfo.InvariantCulture),
longitude: Convert.ToDouble(e.Element("Longitude").Value, CultureInfo.InvariantCulture)
))
.ToList();
}
public class ShipwreckData {
public int Year { get; }
public string Name { get; }
public string Description { get; }
public double Latitude { get; }
public double Longitude { get; }
public ShipwreckData(int year, string name, string description, double latitude, double longitude) {
this.Year = year;
this.Name = name;
this.Description = description;
this.Latitude = latitude;
this.Longitude = longitude;
}
}
' In the Form's constructor.
Dim data As Object = LoadData("..\..\Data\Ships.xml")
' Create a vector layer.
map.Layers.Add(New VectorItemsLayer() With { _
.Data = CreateAdapter(data), _
.ToolTipPattern = "<b>{Name} ({Year})</b> " & ControlChars.CrLf & "{Description}", _
.ItemImageIndex = 0 _
})
' Creates an adapter for the map's vector layer.
Private Function CreateAdapter(ByVal source As Object) As IMapDataAdapter
Dim adapter As New ListSourceDataAdapter()
adapter.DataSource = source
adapter.Mappings.Latitude = "Latitude"
adapter.Mappings.Longitude = "Longitude"
adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Name", .Name = "Name"})
adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Year", .Name = "Year"})
adapter.AttributeMappings.Add(New MapItemAttributeMapping() With {.Member = "Description", .Name = "Description"})
Return adapter
End Function
' Loads data from a XML file.
Private Function LoadData(ByVal path As String) As List(Of ShipwreckData)
Return XDocument.Load(path).Element("Ships").Elements("Ship") _
.Select(Function(e) New ShipwreckData(
year:=Convert.ToInt32(e.Element("Year").Value, CultureInfo.InvariantCulture),
name:=e.Element("Name").Value,
description:=e.Element("Description").Value,
latitude:=Convert.ToDouble(e.Element("Latitude").Value, CultureInfo.InvariantCulture),
longitude:=Convert.ToDouble(e.Element("Longitude").Value, CultureInfo.InvariantCulture)
)) _
.ToList()
End Function
Public Class ShipwreckData
Public ReadOnly Property Year() As Integer
Public ReadOnly Property Name() As String
Public ReadOnly Property Description() As String
Public ReadOnly Property Latitude() As Double
Public ReadOnly Property Longitude() As Double
Public Sub New(ByVal year As Integer, ByVal name As String, ByVal description As String, ByVal latitude As Double, ByVal longitude As Double)
Me.Year = year
Me.Name = name
Me.Description = description
Me.Latitude = latitude
Me.Longitude = longitude
End Sub
End Class
The following example shows how to create map polylines based on a collection of coordinates, and configure the polyline color and thickness.
Follow the steps below to create a vector layer with polylines:
Create a VectorItemsLayer object and add it to the map’s Layers collection.
Create a ListSourceDataAdapter object and assign it to the vector layer’s Data property.
Specify the adapter’s DataSource. The example below uses a list of objects that store information about lines, such as coordinate points.
Set the adapter’s DefaultMapItemType property to MapItemType.Polyline to create polylines based on the data that the adapter loads.
Add a MapPolylinePointCollectionMapping object to the adapter’s PropertyMappings. Specify the following mapping properties to define source fields from which the adapter should obtain polyline point data:
To customize polyline appearance settings, use mappings that correspond to map item properties. For example, add the following mappings to the adapter’s PropertyMappings collection to specify the MapItem.Stroke and MapItem.StrokeWidth properties:
Call the MapControl.ZoomToFitLayerItems() method in the vector layer’s DataLoaded event handler to specify the map viewport boundaries so that they include all polylines.
The code below creates two polylines:
using DevExpress.XtraMap;
using System.Collections.Generic;
using System.Drawing;
using System.Windows.Forms;
namespace CreateMapLines {
public partial class Form1 : Form {
public Form1() {
InitializeComponent();
// Create a background image layer and add it to the map.
ImageLayer imageLayer = new ImageLayer();
imageLayer.DataProvider = new BingMapDataProvider {
BingKey = "Insert your Bing Maps key here.",
Kind = BingMapKind.RoadGray
};
mapControl1.Layers.Add(imageLayer);
// Create a vector layer and add it to the map.
VectorItemsLayer vectorLayer = new VectorItemsLayer();
mapControl1.Layers.Add(vectorLayer);
// Create a ListSourceDataAdapter.
// Specify its data source.
// Configure mappings.
// Assign the adapter to the vector layer.
ListSourceDataAdapter adapter = new ListSourceDataAdapter();
adapter.DataSource = GetLines();
adapter.DefaultMapItemType = MapItemType.Polyline;
adapter.PropertyMappings.Add(new MapPolylinePointCollectionMapping {
XCoordinateMember = "Longitude",
PointSourceMember = "PointSource",
YCoordinateMember= "Latitude"
});
adapter.PropertyMappings.Add(new MapItemStrokeMapping { Member = "Color" });
adapter.PropertyMappings.Add(new MapItemStrokeWidthMapping { DefaultValue = 4 });
vectorLayer.Data = adapter;
vectorLayer.DataLoaded += OnVectorLayerDataLoaded;
}
private void OnVectorLayerDataLoaded(object sender, DataLoadedEventArgs e) {
// Zooms the map to fit all created lines.
mapControl1.ZoomToFitLayerItems();
}
public List<Line> GetLines() {
List<Line> lines = new List<Line>();
Line line1 = new Line();
line1.PointSource.Add(new Coordinate(-5.93107, -35.112723));
line1.PointSource.Add(new Coordinate(-10.13507, -25.15696));
line1.PointSource.Add(new Coordinate(-5.183714, -8.911391));
line1.PointSource.Add(new Coordinate(4.253438, 5.47072));
line1.Color = Color.Green;
lines.Add(line1);
Line line2 = new Line();
line2.PointSource.Add(new Coordinate(1, 0.5));
line2.PointSource.Add(new Coordinate(-25, -15));
line2.PointSource.Add(new Coordinate(-15, -25));
line2.PointSource.Add(new Coordinate(-22.1531, -41.45984));
line2.Color = Color.Red;
lines.Add(line2);
return lines;
}
}
public struct Coordinate {
public double Latitude { get; }
public double Longitude { get; }
public Coordinate(double lat, double lon) {
Latitude = lat;
Longitude = lon;
}
}
public class Line {
public Color Color { get; set; }
public List<Coordinate> PointSource { get; } = new List<Coordinate>();
}
}
Imports DevExpress.XtraMap
Imports System.Collections.Generic
Imports System.Drawing
Imports System.Windows.Forms
Namespace CreateMapLines
Public Partial Class Form1
Inherits Form
Public Sub New()
InitializeComponent()
' Create a background image layer and add it to the map.
Dim imageLayer As ImageLayer = New ImageLayer()
imageLayer.DataProvider = New BingMapDataProvider With {
.BingKey = "Insert your Bing Maps key here.",
.Kind = BingMapKind.RoadGray
}
mapControl1.Layers.Add(imageLayer)
' Create a vector layer and add it to the map.
Dim vectorLayer As VectorItemsLayer = New VectorItemsLayer()
mapControl1.Layers.Add(vectorLayer)
' Create a ListSourceDataAdapter.
' Specify its data source.
' Configure mappings.
' Assign the adapter to the vector layer.
Dim adapter As ListSourceDataAdapter = New ListSourceDataAdapter()
adapter.DataSource = GetLines()
adapter.DefaultMapItemType = MapItemType.Polyline
adapter.PropertyMappings.Add(New MapPolylinePointCollectionMapping With {
.XCoordinateMember = "Longitude",
.PointSourceMember = "PointSource",
.YCoordinateMember = "Latitude"
})
adapter.PropertyMappings.Add(New MapItemStrokeMapping With {
.Member = "Color"
})
adapter.PropertyMappings.Add(New MapItemStrokeWidthMapping With {
.DefaultValue = 4
})
vectorLayer.Data = adapter
vectorLayer.DataLoaded += AddressOf OnVectorLayerDataLoaded
End Sub
Private Sub OnVectorLayerDataLoaded(ByVal sender As Object, ByVal e As DataLoadedEventArgs)
' Zooms the map so that it displays all created lines.
mapControl1.ZoomToFitLayerItems()
End Sub
Public Function GetLines() As List(Of Line)
Dim lines As List(Of Line) = New List(Of Line)()
Dim line1 As Line = New Line()
line1.PointSource.Add(New Coordinate(-5.93107, -35.112723))
line1.PointSource.Add(New Coordinate(-10.13507, -25.15696))
line1.PointSource.Add(New Coordinate(-5.183714, -8.911391))
line1.PointSource.Add(New Coordinate(4.253438, 5.47072))
line1.Color = Color.Green
lines.Add(line1)
Dim line2 As Line = New Line()
line2.PointSource.Add(New Coordinate(1, 0.5))
line2.PointSource.Add(New Coordinate(-25, -15))
line2.PointSource.Add(New Coordinate(-15, -25))
line2.PointSource.Add(New Coordinate(-22.1531, -41.45984))
line2.Color = Color.Red
lines.Add(line2)
Return lines
End Function
End Class
Public Structure Coordinate
Public ReadOnly Property Latitude As Double
Public ReadOnly Property Longitude As Double
Public Sub New(ByVal lat As Double, ByVal lon As Double)
Latitude = lat
Longitude = lon
End Sub
End Structure
Public Class Line
Public Property Color As Color
Public ReadOnly Property PointSource As List(Of Coordinate) = New List(Of Coordinate)()
End Class
End Namespace
The following example shows how to create map polygons based on a collection of coordinates, and configure the polygon stroke and fill colors.
Follow the steps below to create a vector layer with polygons:
Create a VectorItemsLayer object and add it to the map’s Layers collection.
Create a ListSourceDataAdapter object and assign it to the vector layer’s Data property.
Specify the adapter’s DataSource. The example below uses a list of objects that store information about polygons, such as coordinate points.
Set the adapter’s DefaultMapItemType property to MapItemType.Polygon to create polygon based on the data that the adapter loads.
Add a MapPolygonPointCollectionMapping object to the adapter’s PropertyMappings. Specify the following mapping properties to define source fields from which the adapter should obtain polygon point data:
To customize polygon appearance settings, use mappings that correspond to map item properties. For example, add the following mappings to the adapter’s PropertyMappings collection to specify the MapItem.Stroke, MapItem.Fill, and MapItem.StrokeWidth properties:
Call the MapControl.ZoomToFitLayerItems() method in the vector layer’s DataLoaded event handler to specify the map viewport boundaries so that they include all polygons.
The code below creates two polygons:
using DevExpress.XtraMap;
using System.Collections.Generic;
using System.Drawing;
using System.Windows.Forms;
namespace CreateMapPolygons {
public partial class Form1 : Form {
public Form1() {
InitializeComponent();
// Create a background image layer and add it to the map.
ImageLayer imageLayer = new ImageLayer();
imageLayer.DataProvider = new BingMapDataProvider {
BingKey = "Insert your Bing Maps key here.",
Kind = BingMapKind.RoadGray
};
mapControl1.Layers.Add(imageLayer);
// Create a vector layer and add it to the map.
VectorItemsLayer vectorLayer = new VectorItemsLayer();
mapControl1.Layers.Add(vectorLayer);
// Create a ListSourceDataAdapter.
// Specify its data source.
// Configure mappings.
// Assign the adapter to the vector layer.
ListSourceDataAdapter adapter = new ListSourceDataAdapter();
adapter.DataSource = GetPolygons();
adapter.DefaultMapItemType = MapItemType.Polygon;
adapter.PropertyMappings.Add(new MapPolygonPointCollectionMapping {
XCoordinateMember = "Longitude",
PointSourceMember = "PointSource",
YCoordinateMember = "Latitude"
});
adapter.PropertyMappings.Add(new MapItemStrokeMapping { Member = "StrokeColor" });
adapter.PropertyMappings.Add(new MapItemFillMapping { Member = "FillColor" });
adapter.PropertyMappings.Add(new MapItemStrokeWidthMapping { DefaultValue = 4 });
vectorLayer.Data = adapter;
vectorLayer.DataLoaded += OnVectorLayerDataLoaded;
}
private void OnVectorLayerDataLoaded(object sender, DataLoadedEventArgs e) {
// Zooms the map so that it displays all created polygons.
mapControl1.ZoomToFitLayerItems(paddingFactor: 0.5);
}
public List<Polygon> GetPolygons() {
List<Polygon> polygons = new List<Polygon>();
Polygon polygon1 = new Polygon();
polygon1.PointSource.Add(new Coordinate(-3.5, -30.3));
polygon1.PointSource.Add(new Coordinate(-2.4, -9.8));
polygon1.PointSource.Add(new Coordinate(-9.0, -19.4));
polygon1.PointSource.Add(new Coordinate(-12.9, -31.1));
polygon1.StrokeColor = Color.Green;
polygon1.FillColor = Color.White;
polygons.Add(polygon1);
Polygon polygon2 = new Polygon();
polygon2.PointSource.Add(new Coordinate(-13.5, -9.6));
polygon2.PointSource.Add(new Coordinate(-17.5, 0.3));
polygon2.PointSource.Add(new Coordinate(-21.8, -7.8));
polygon2.StrokeColor = Color.Red;
polygon2.FillColor = Color.DarkGray;
polygons.Add(polygon2);
return polygons;
}
}
public struct Coordinate {
public double Latitude { get; }
public double Longitude { get; }
public Coordinate(double lat, double lon) {
Latitude = lat;
Longitude = lon;
}
}
public class Polygon {
public Color StrokeColor { get; set; }
public Color FillColor { get; set; }
public List<Coordinate> PointSource { get; } = new List<Coordinate>();
}
}
Imports DevExpress.XtraMap
Imports System.Collections.Generic
Imports System.Drawing
Imports System.Windows.Forms
Namespace CreateMapPolygons
Public Partial Class Form1
Inherits Form
Public Sub New()
InitializeComponent()
' Create a background image layer and add it to the map.
Dim imageLayer As ImageLayer = New ImageLayer()
imageLayer.DataProvider = New BingMapDataProvider With {
.BingKey = "Insert your Bing Maps key here.",
.Kind = BingMapKind.RoadGray
}
mapControl1.Layers.Add(imageLayer)
' Create a vector layer and add it to the map.
Dim vectorLayer As VectorItemsLayer = New VectorItemsLayer()
mapControl1.Layers.Add(vectorLayer)
' Create a ListSourceDataAdapter.
' Specify its data source.
' Configure mappings.
' Assign the adapter to the vector layer.
Dim adapter As ListSourceDataAdapter = New ListSourceDataAdapter()
adapter.DataSource = GetPolygons()
adapter.DefaultMapItemType = MapItemType.Polygon
adapter.PropertyMappings.Add(New MapPolygonPointCollectionMapping With {
.XCoordinateMember = "Longitude",
.PointSourceMember = "PointSource",
.YCoordinateMember = "Latitude"
})
adapter.PropertyMappings.Add(New MapItemStrokeMapping With {
.Member = "StrokeColor"
})
adapter.PropertyMappings.Add(New MapItemFillMapping With {
.Member = "FillColor"
})
adapter.PropertyMappings.Add(New MapItemStrokeWidthMapping With {
.DefaultValue = 4
})
vectorLayer.Data = adapter
vectorLayer.DataLoaded += AddressOf OnVectorLayerDataLoaded
End Sub
Private Sub OnVectorLayerDataLoaded(ByVal sender As Object, ByVal e As DataLoadedEventArgs)
' Zooms the map so that it displays all created polygons.
mapControl1.ZoomToFitLayerItems(paddingFactor:=0.5)
End Sub
Public Function GetPolygons() As List(Of Polygon)
Dim polygons As List(Of Polygon) = New List(Of Polygon)()
Dim polygon1 As Polygon = New Polygon()
polygon1.PointSource.Add(New Coordinate(-3.5, -30.3))
polygon1.PointSource.Add(New Coordinate(-2.4, -9.8))
polygon1.PointSource.Add(New Coordinate(-9.0, -19.4))
polygon1.PointSource.Add(New Coordinate(-12.9, -31.1))
polygon1.StrokeColor = Color.Green
polygon1.FillColor = Color.White
polygons.Add(polygon1)
Dim polygon2 As Polygon = New Polygon()
polygon2.PointSource.Add(New Coordinate(-13.5, -9.6))
polygon2.PointSource.Add(New Coordinate(-17.5, 0.3))
polygon2.PointSource.Add(New Coordinate(-21.8, -7.8))
polygon2.StrokeColor = Color.Red
polygon2.FillColor = Color.DarkGray
polygons.Add(polygon2)
Return polygons
End Function
End Class
Public Structure Coordinate
Public ReadOnly Property Latitude As Double
Public ReadOnly Property Longitude As Double
Public Sub New(ByVal lat As Double, ByVal lon As Double)
Latitude = lat
Longitude = lon
End Sub
End Structure
Public Class Polygon
Public Property StrokeColor As Color
Public Property FillColor As Color
Public ReadOnly Property PointSource As List(Of Coordinate) = New List(Of Coordinate)()
End Class
End Namespace
Object MapDisposableObject MapDataAdapterBase CoordinateSystemDataAdapterBase DataSourceAdapterBase ListSourceDataAdapter
See Also