HierarchicalDataMapping.LabelDataMember Property

Gets or sets the name of the data field whose values are used to specify the tree map or sunburst items’ labels.

Assembly : DevExpress.XtraTreeMap.v25.2.dll

Declaration

C#
VB.NET

csharp

[DefaultValue(null)]
[XtraSerializableProperty]
public string LabelDataMember { get; set; }

<DefaultValue(Nothing)>
<XtraSerializableProperty>
Public Property LabelDataMember As String

Property Value

Type	Default	Description
String	null

A String value.

Example

To provide hierarchical data to a TreeMap, create a TreeMapHierarchicalDataAdapter object and assign it to the TreeMapControl.DataAdapter property. Then, specify the adapter’s data source object using the TreeMapHierarchicalDataAdapter.DataSource property. To configure how hierarchical data should be converted to tree map items, use HierarchicalDataMapping objects. The HierarchicalDataMapping.LabelDataMember property allows you to specify a label data member, the HierarchicalDataMapping.ValueDataMember property - a value data member, the HierarchicalDataMapping.ChildrenDataMember property - a data member containing children items, and the HierarchicalDataMapping.Type property - the type of items on the current nesting level.

Form1.cs
Form1.vb

csharp

void CreateTreeMapDataAdapter() {
    TreeMapHierarchicalDataAdapter dataAdapter = new TreeMapHierarchicalDataAdapter();
    dataAdapter.DataSource = CreateStatistics();

    // Fill the Mappings collection using mappings specifying 
    // how to convert data objects to tree map items.
    dataAdapter.Mappings.Add(new TreeMapHierarchicalDataMapping {
        Type = typeof(CountryStatistics),
        LabelDataMember = "Name",
        ChildrenDataMember = "EnergyStatistics"
    });
    dataAdapter.Mappings.Add(new TreeMapHierarchicalDataMapping {
        Type = typeof(EnergyInfo),
        LabelDataMember = "Type",
        ValueDataMember = "Value"
    });

    treeMap.DataAdapter = dataAdapter;
}

Private Sub CreateTreeMapDataAdapter()
    Dim dataAdapter As New TreeMapHierarchicalDataAdapter()
    dataAdapter.DataSource = CreateStatistics()

    ' Fill the Mappings collection using mappings specifying 
    ' how to convert data objects to tree map items.
    dataAdapter.Mappings.Add(New TreeMapHierarchicalDataMapping With {.Type = GetType(CountryStatistics), .LabelDataMember = "Name", .ChildrenDataMember = "EnergyStatistics"})
    dataAdapter.Mappings.Add(New TreeMapHierarchicalDataMapping With {.Type = GetType(EnergyInfo), .LabelDataMember = "Type", .ValueDataMember = "Value"})

    treeMap.DataAdapter = dataAdapter
End Sub