TreeMapHierarchicalDataAdapter.Mappings Property

Returns the collection of data object mappings to tree map items.

Namespace: DevExpress.XtraTreeMap

Assembly: DevExpress.XtraTreeMap.v20.1.dll

Declaration

[XtraSerializableProperty(XtraSerializationVisibility.Collection, true)]
public IList<TreeMapHierarchicalDataMapping> Mappings { get; }
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True)>
Public ReadOnly Property Mappings As IList(Of TreeMapHierarchicalDataMapping)

Property Value

Type Description
IList<TreeMapHierarchicalDataMapping>

A list of TreeMapHierarchicalDataMapping objects.

Examples

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.

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;
}
See Also