Generate Diagrams from Flat Data

• Jul 02, 2024
• 4 minutes to read

You can use the DiagramDataBindingController class to generate single and multi-level diagrams from flat (non-hierarchical) data.

View Example: Use DiagramDataBindingController to Generate a Diagram from a Collection

Set Up the Behavior

Attach DiagramDataBindingController in one of two ways:

• Open the DiagramControl‘s Smart Tag and select Add DataBindingController:

  

• Add DiagramDataBindingController in code:

  C#

  diagramDataBindingController1 = new DevExpress.XtraDiagram.DiagramDataBindingController();
  diagramDataBindingController1.Diagram = diagramControl1;
  

  VB.NET

  diagramDataBindingController1 = New DevExpress.XtraDiagram.DiagramDataBindingController()
  diagramDataBindingController1.Diagram = diagramControl1
  

Use the following properties to define source collections for shapes/containers and connectors:

Property	Description
KeyMember	Specifies a data source property that uniquely identifies shapes/containers.
DataSource	Specifies a source collection of data items that describe shapes/containers.
ConnectorsSource	Specifies a source collection of data items that describe connectors.
ConnectorFromMember	Specifies a connector item property that identifies the start item by its KeyMember.
ConnectorToMember	Specifies a connector item property that identifies the end item by its KeyMember.

DiagramDataBindingController identifies items by their instances if you do not specify the KeyMember property.

You can also use the controller’s Smart Tag to configure DiagramDataBindingController at design-time:

Define and Configure Generated Diagram Items

You can use the following techniques to define and configure generated items:

• Item Template Designer
• Define Generated Items at Runtime

Usage Notes

DiagramDataBindingController can obtain values only from strongly typed objects. You cannot bind it to dynamic properties.

Example

The following example demonstrates the DiagramControl bound to sample data:

C#

public class ViewModel {
    public List<Item> Items { get; set; }
    public List<Link> Connections { get; set; }
    public ViewModel() {
        Items = new List<Item>();
        for (int i = 0; i < 5; i++)
            Items.Add(new Item { Id = i, Name = "Item " + i });
        Connections = new List<Link>();
        for (int i = 0; i < 4; i++)
            Connections.Add(new Link { From = Items[i].Id, To = Items[i + 1].Id });
        Connections.Add(new Link { From = Items[4].Id, To = Items[0].Id });
    }
}
public class Item {
    public int Id { get; set; }
    public string Name { get; set; }
}

public class Link {
    public object From { get; set; }
    public object To { get; set; }
}

VB.NET

 Public Class ViewModel
    Public Property Items() As List(Of Item)
    Public Property Connections() As List(Of Link)
    Public Sub New()
        Items = New List(Of Item)()
        For i As Integer = 0 To 4
            Items.Add(New Item With {
                .Id = i,
                .Name = "Item " & i
            })
        Next i
        Connections = New List(Of Link)()
        For i As Integer = 0 To 3
            Connections.Add(New Link With {
                .From = Items(i).Id,
                .To = Items(i + 1).Id
            })
        Next i
        Connections.Add(New Link With {
            .From = Items(4).Id,
            .To = Items(0).Id
        })
    End Sub
End Class
Public Class Item
    Public Property Id() As Integer
    Public Property Name() As String
End Class

Public Class Link
    Public Property From() As Object
    Public Property [To]() As Object
End Class

C#

 public Form1() {
    InitializeComponent();
    ViewModel viewModel = new ViewModel();
    diagramDataBindingController1.GenerateItem += DiagramDataBindingController1_GenerateItem;
    diagramDataBindingController1.DataSource = viewModel.Items;
    diagramDataBindingController1.KeyMember = "Id";
    diagramDataBindingController1.ConnectorsSource = viewModel.Connections;
    diagramDataBindingController1.ConnectorFromMember = "From";
    diagramDataBindingController1.ConnectorToMember = "To";
    diagramDataBindingController1.LayoutKind = DiagramLayoutKind.Circular;
}
private void DiagramDataBindingController1_GenerateItem(object sender, DiagramGenerateItemEventArgs e) {
    var item = new DiagramShape {
        X = 27,
        Width = 75,
        Height = 50,
        Shape = BasicShapes.Rectangle
    };
    item.Bindings.Add(new DiagramBinding("Content", "Name"));
    e.Item = item;
}

VB.NET

Public Sub New()
    InitializeComponent()
    Dim viewModel As New ViewModel()
    AddHandler diagramDataBindingController1.GenerateItem, AddressOf DiagramDataBindingController1_GenerateItem
    diagramDataBindingController1.DataSource = viewModel.Items
    diagramDataBindingController1.KeyMember = "Id"
    diagramDataBindingController1.ConnectorsSource = viewModel.Connections
    diagramDataBindingController1.ConnectorFromMember = "From"
    diagramDataBindingController1.ConnectorToMember = "To"
    diagramDataBindingController1.LayoutKind = DiagramLayoutKind.Circular
End Sub
Private Sub DiagramDataBindingController1_GenerateItem(ByVal sender As Object, ByVal e As DiagramGenerateItemEventArgs)
    Dim item = New DiagramShape With {
        .X = 27,
        .Width = 75,
        .Height = 50,
        .Shape = BasicShapes.Rectangle
    }
    item.Bindings.Add(New DiagramBinding("Content", "Name"))
    e.Item = item
End Sub