SankeyDiagramControl.HighlightedItemsChanged Event

Occurs when a collection of highlighted items (links or nodes) is changed.

Namespace: DevExpress.XtraCharts.Sankey

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

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public event SankeyHighlightedItemsChangedEventHandler HighlightedItemsChanged

VB.NET

Public Event HighlightedItemsChanged As SankeyHighlightedItemsChangedEventHandler

Event Data

The HighlightedItemsChanged event's data class is SankeyHighlightedItemsChangedEventArgs. The following properties provide information specific to this event:

Property	Description
HighlightedLinks	Returns a collection of highlighted diagram links.
HighlightedNodes	Returns a collection of highlighted diagram nodes.

Remarks

The following code tracks changes to highlighted diagram items:

C#

void HighlightedItemsChanged(object sender, SankeyHighlightedItemsChangedEventArgs e) {
    var list = e.HighlightedLinks.Select(x => (Export)x.Tags[0]);
    HighlightArrows(list);
}

VB.NET

Private Sub HighlightedItemsChanged(ByVal sender As Object, ByVal e As SankeyHighlightedItemsChangedEventArgs) Handles sankeyDiagramControl1.HighlightedItemsChanged
    Dim list = e.HighlightedLinks.Select(Function(x) CType(x.Tags(0), Export))
    HighlightArrows(list)
End Sub

Note

Run the following demo for the complete example: Tooltip

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HighlightedItemsChanged event.

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#L34

    sankey.SelectedItemsChanging += Sankey_SelectedItemsChanging;
    sankey.HighlightedItemsChanged += Sankey_HighlightedItemsChanged;
}

VB.NET

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

    AddHandler sankey.SelectedItemsChanging, AddressOf Sankey_SelectedItemsChanging
    AddHandler sankey.HighlightedItemsChanged, AddressOf Sankey_HighlightedItemsChanged
End Sub