Back to Devexpress

SankeyDiagramControl.HighlightedItemsChanged Event

windowsforms-devexpress-dot-xtracharts-dot-sankey-dot-sankeydiagramcontrol-a294c278.md

latest4.0 KB
Original Source

SankeyDiagramControl.HighlightedItemsChanged Event

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

Namespace : DevExpress.XtraCharts.Sankey

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

NuGet Package : DevExpress.Win.Charts

Declaration

csharp
public event SankeyHighlightedItemsChangedEventHandler HighlightedItemsChanged
vb
Public Event HighlightedItemsChanged As SankeyHighlightedItemsChangedEventHandler

Event Data

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

PropertyDescription
HighlightedLinksReturns a collection of highlighted diagram links.
HighlightedNodesReturns a collection of highlighted diagram nodes.

Remarks

The following code tracks changes to highlighted diagram items:

csharp
void HighlightedItemsChanged(object sender, SankeyHighlightedItemsChangedEventArgs e) {
    var list = e.HighlightedLinks.Select(x => (Export)x.Tags[0]);
    HighlightArrows(list);
}
vb
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

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.

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

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

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

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

See Also

SankeyDiagramControl Class

SankeyDiagramControl Members

DevExpress.XtraCharts.Sankey Namespace