Back to Devexpress

CustomizeHeatmapToolTipEventArgs Class

corelibraries-devexpress-dot-xtracharts-dot-heatmap-7946734f.md

latest4.1 KB
Original Source

CustomizeHeatmapToolTipEventArgs Class

Provides data for the CustomizeHeatmapToolTip event.

Namespace : DevExpress.XtraCharts.Heatmap

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
public class CustomizeHeatmapToolTipEventArgs :
    EventArgs
vb
Public Class CustomizeHeatmapToolTipEventArgs
    Inherits EventArgs

CustomizeHeatmapToolTipEventArgs is the data class for the following events:

Example

This example shows how to use the HeatmapControl.CustomizeHeatmapToolTip event to modify tooltip content based on the cell value for which the tooltip is shown.

Follow the steps below to enable and customize tooltips:

The code below applies a custom format to tooltip text if a heatmap cell value is more than the specified value:

csharp
const int ThresholdValue = 50;

public Form1() {
    InitializeComponent();
    // ...
    heatmap.ToolTipEnabled = true;
    heatmap.ToolTipController = new DevExpress.Utils.ToolTipController { AllowHtmlText = true };
    heatmap.CustomizeHeatmapToolTip += OnHeatmapCustomizeHeatmapToolTip;
}

private void OnHeatmapCustomizeHeatmapToolTip(object sender, CustomizeHeatmapToolTipEventArgs e) {
    double cellValue = (double)e.HeatmapCell.ColorValue;
    if (cellValue > ThresholdValue) {
        e.Title = "Sale Info";
        e.Text = $"Total: <color=green>${cellValue}K</color>";
    }
}
vb
Const ThresholdValue As Integer = 50

Public Sub New()
    heatmap.ToolTipEnabled = True
    heatmap.ToolTipController = New DevExpress.Utils.ToolTipController With {
        .AllowHtmlText = True
    }
    heatmap.CustomizeHeatmapToolTip += AddressOf OnHeatmapCustomizeHeatmapToolTip
End Sub

Private Sub OnHeatmapCustomizeHeatmapToolTip(ByVal sender As Object, ByVal e As CustomizeHeatmapToolTipEventArgs)
    Dim cellValue As Double = CDbl(e.HeatmapCell.ColorValue)

    If cellValue > ThresholdValue Then
        e.Title = "Sale Info"
        e.Text = $"Total: <color=green>${cellValue}K</color>"
    End If
End Sub

Inheritance

Object EventArgs CustomizeHeatmapToolTipEventArgs

See Also

CustomizeHeatmapToolTipEventArgs Members

DevExpress.XtraCharts.Heatmap Namespace