TreeMapHierarchicalDataAdapter.DataSource Property

Gets or sets the object that is the data source of the data adapter.

Namespace: DevExpress.XtraTreeMap

Assembly: DevExpress.XtraTreeMap.v18.2.dll

Declaration

C#

[DefaultValue(null)]
public object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataSource As Object

Property Value

Type	Default	Description
Object	*null*	A Object that is the data source.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-provide-hierarchical-data-to-treemap-t360961

Form1.cs

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

Form1.vb

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-color-treemap-items-using-range-colorizer-t361287/CS/RangeColorizerSample/Form1.cs#L21

TreeMapHierarchicalDataAdapter dataAdapter = new TreeMapHierarchicalDataAdapter();
dataAdapter.DataSource = CreateStatistics();

how-to-provide-hierarchical-data-to-treemap-t360961/CS/HierarchicalDataAdapterSample/Form1.cs#L22

TreeMapHierarchicalDataAdapter dataAdapter = new TreeMapHierarchicalDataAdapter();
dataAdapter.DataSource = CreateStatistics();

VB.NET

how-to-color-treemap-items-using-range-colorizer-t361287/VB/RangeColorizerSample/Form1.vb#L23

Dim dataAdapter As New TreeMapHierarchicalDataAdapter()
dataAdapter.DataSource = CreateStatistics()

how-to-provide-hierarchical-data-to-treemap-t360961/VB/HierarchicalDataAdapterSample/Form1.vb#L24

Dim dataAdapter As New TreeMapHierarchicalDataAdapter()
dataAdapter.DataSource = CreateStatistics()