Back to Devexpress

SunburstFlatDataAdapter.ValueDataMember Property

windowsforms-devexpress-dot-xtratreemap-dot-sunburstflatdataadapter.md

latest5.1 KB
Original Source

SunburstFlatDataAdapter.ValueDataMember Property

Gets or sets the name of the data field whose values are used to generate SunburstItem.Value values.

Namespace : DevExpress.XtraTreeMap

Assembly : DevExpress.XtraTreeMap.v25.2.dll

NuGet Package : DevExpress.TreeMap

Declaration

csharp
[DefaultValue("")]
[XtraSerializableProperty]
public string ValueDataMember { get; set; }
vb
<DefaultValue("")>
<XtraSerializableProperty>
Public Property ValueDataMember As String

Property Value

TypeDefaultDescription
StringString.Empty

A String value.

|

Example

This example demonstrates how to visualize flat data using the SunburstControl.

Create a SunburstFlatDataAdapter object and assign it to the SunburstControl.DataAdapter property to provide flat data to the Sunburst. Then, specify the adapter’s SunburstFlatDataAdapter.DataSource, SunburstFlatDataAdapter.LabelDataMember and SunburstFlatDataAdapter.ValueDataMember to define data source members that should be used to generate sunburst items. Add data members to the SunburstFlatDataAdapter.GroupDataMembers collection to specify how to group the sunburst’s items.

csharp
private void OnLoad(object sender, EventArgs e) {
    SunburstFlatDataAdapter dataAdapter = new SunburstFlatDataAdapter();            
    dataAdapter.ValueDataMember = "Annual";
    dataAdapter.LabelDataMember = "Product";
    dataAdapter.GroupDataMembers.AddRange(new string[] { "Category", "Country" });
    dataAdapter.DataSource = CreateProductInfos();
    sunburstControl.DataAdapter = dataAdapter;
}
vb
Class SurroundingClass
    Private Sub OnLoad(ByVal sender As Object, ByVal e As EventArgs)
        Dim dataAdapter As SunburstFlatDataAdapter = New SunburstFlatDataAdapter()
        dataAdapter.ValueDataMember = "Annual" 
        dataAdapter.LabelDataMember = "Product" 
        dataAdapter.GroupDataMembers.AddRange(New String() {"Category", "Country"})
        dataAdapter.DataSource = CreateProductInfos()
        sunburstControl.DataAdapter = dataAdapter
    End Sub 
End Class

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ValueDataMember 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.

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/SunburstChart/SunburstItemControlProvider.cs#L68

csharp
sunburst.Colorizer = null;
dataAdapter.DataSource = dataAdapter.ValueDataMember = dataAdapter.LabelDataMember = null;
dataAdapter.GroupDataMembers.Clear();

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/SunburstChart/SunburstItemControlProvider.vb#L78

vb
dataAdapter.LabelDataMember = Nothing
dataAdapter.ValueDataMember = dataAdapter.LabelDataMember
dataAdapter.DataSource = dataAdapter.ValueDataMember

See Also

Provide Data

SunburstFlatDataAdapter Class

SunburstFlatDataAdapter Members

DevExpress.XtraTreeMap Namespace