SankeyDiagramControl.SelectionMode Property

Specifies the selection mode for Sankey nodes and links.

Namespace: DevExpress.XtraCharts.Sankey

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

Declaration

C#

public SankeySelectionMode SelectionMode { get; set; }

VB.NET

Public Property SelectionMode As SankeySelectionMode

Property Value

Type	Description
SankeySelectionMode	A value that defines Sankey selection mode.

Available values:

Name	Description	Example
None	A user cannot select Sankey links and nodes.
Single	A user can select a single Sankey link or a node with the related links.
Multiple	A user can select multiple Sankey links and nodes.
Extended	A user can select a single Sankey link or a node with the related links. A user can hold down the Shift or Ctrl key to select multiple Sankey links and nodes.

Remarks

The following code allows a user to select multiple Sankey elements:

C#

private void Form1_Load(object sender, EventArgs e) {
    sankeyDiagramControl1.SelectionMode = SankeySelectionMode.Multiple;
}

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    sankeyDiagramControl1.SelectionMode = SankeySelectionMode.Multiple
End Sub

Related GitHub Examples

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

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.cs#L56

void Sankey_HighlightedItemsChanged(object sender, SankeyHighlightedItemsChangedEventArgs e) {
    if((sankey.SelectionMode == SankeySelectionMode.Single && e.HighlightedNodes.Count > 0) || e.HighlightedLinks.Any(x => HasSpecialValues(x)))
        sankey.HighlightedItems.Clear();

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/SankeyChart/SankeyItemControlProvider.vb#L65

Private Sub Sankey_HighlightedItemsChanged(ByVal sender As Object, ByVal e As SankeyHighlightedItemsChangedEventArgs)
    If (sankey.SelectionMode = SankeySelectionMode.Single AndAlso e.HighlightedNodes.Count > 0) OrElse e.HighlightedLinks.Any(Function(x) HasSpecialValues(x)) Then
        sankey.HighlightedItems.Clear()