Back to Devexpress

SankeyDiagramControl.SelectedItems Property

windowsforms-devexpress-dot-xtracharts-dot-sankey-dot-sankeydiagramcontrol-542bf1f2.md

latest4.4 KB
Original Source

SankeyDiagramControl.SelectedItems Property

Returns the collection of selected Sankey links and nodes.

Namespace : DevExpress.XtraCharts.Sankey

Assembly : DevExpress.XtraCharts.v25.2.UI.dll

NuGet Package : DevExpress.Win.Charts

Declaration

csharp
[Browsable(false)]
public IList SelectedItems { get; }
vb
<Browsable(False)>
Public ReadOnly Property SelectedItems As IList

Property Value

TypeDescription
IList

The collection of selected Sankey links and nodes.

|

Remarks

Add links and nodes to the SelectedItems collection to select them. When you use the SelectedItems property to change the Sankey element selection, the SankeyDiagramControl ignores whether the selection is enabled in the SelectionMode property.

The following example selects the France node and the related links:

csharp
List<SankeyItem> data = new List<SankeyItem> {
    new SankeyItem { Source = "France", Target = "UK", Value = 53 },
    new SankeyItem { Source = "Australia", Target = "UK", Value = 72 },
    new SankeyItem { Source = "France", Target = "Canada", Value = 81 },
    new SankeyItem { Source = "China", Target = "Canada", Value = 96 },
    new SankeyItem { Source = "UK", Target = "France", Value = 61 },
    new SankeyItem { Source = "Canada", Target = "France", Value = 89 }
};
sankeyDiagramControl1.DataSource = data;
sankeyDiagramControl1.SourceDataMember = "Source";
sankeyDiagramControl1.TargetDataMember = "Target";
sankeyDiagramControl1.WeightDataMember = "Value";
sankeyDiagramControl1.Titles.Add(new SankeyTitle { Text = "Export/Import", Font = new Font("Tahoma", 14) });

sankeyDiagramControl1.SelectedItems.Add("France");
sankeyDiagramControl1.SelectedItems.Add(data[0]);
sankeyDiagramControl1.SelectedItems.Add(data[2]);
sankeyDiagramControl1.SelectedItems.Add(data[5]);
vb
Dim data As List(Of SankeyItem) = New List(Of SankeyItem) From {
        New SankeyItem With {
            .Source = "France",
            .Target = "UK",
            .Value = 53
        },
        New SankeyItem With {
            .Source = "Australia",
            .Target = "UK",
            .Value = 72
        },
        New SankeyItem With {
            .Source = "France",
            .Target = "Canada",
            .Value = 81
        },
        New SankeyItem With {
            .Source = "China",
            .Target = "Canada",
            .Value = 96
        },
        New SankeyItem With {
            .Source = "UK",
            .Target = "France",
            .Value = 61
        },
        New SankeyItem With {
            .Source = "Canada",
            .Target = "France",
            .Value = 89
        }
    }
    sankeyDiagramControl1.DataSource = data
    sankeyDiagramControl1.SourceDataMember = "Source"
    sankeyDiagramControl1.TargetDataMember = "Target"
    sankeyDiagramControl1.WeightDataMember = "Value"
    sankeyDiagramControl1.Titles.Add(New SankeyTitle With {
        .Text = "Export/Import",
        .Font = New Font("Tahoma", 14)
    })
    sankeyDiagramControl1.SelectedItems.Add("France")
    sankeyDiagramControl1.SelectedItems.Add(data(0))
    sankeyDiagramControl1.SelectedItems.Add(data(2))
    sankeyDiagramControl1.SelectedItems.Add(data(5))
}

See Also

SelectedItemsChanging

SelectedItemsChanged

SankeyDiagramControl Class

SankeyDiagramControl Members

DevExpress.XtraCharts.Sankey Namespace