Skip to main content
All docs
V25.1
  • HeatmapToolTipOptions Class

    Contains options for heatmap cell tooltips.

    Namespace: DevExpress.Xpf.Charts.Heatmap

    Assembly: DevExpress.Xpf.Charts.v25.1.dll

    NuGet Package: DevExpress.Wpf.Charts

    Declaration

    public class HeatmapToolTipOptions :
        NotificationElement

    The following members return HeatmapToolTipOptions objects:

    Remarks

    The HeatmapToolTipOptions include the following settings:

    • AutoPopDelay – Gets or sets the time interval during which the tooltip is displayed.

    • CloseOnClick – Specifies whether a tooltip is closed when its corresponding visual element is clicked.

    • InitialDelay – Gets or sets the delay before the tooltip is displayed.

    • OpenMode – Specifies when heatmap tooltips are displayed.

    • Pattern – Gets or sets a format string that is applied to tooltip text.

    Example

    The following example shows how to enable tooltips for heatmap cells and configure tooltip options:

    Customized tooltip

    <Window.Resources>
        <DataTemplate x:Key="tooltipTemplate">
            <StackPanel Orientation="Vertical" Margin="8">
                <Label Foreground="Black" 
                       FontStyle="Italic" 
                       FontSize="14" 
                       Content="{Binding Path=ToolTipText}" />
            </StackPanel>
        </DataTemplate>
    </Window.Resources>
    <Grid>
        <dxh:HeatmapControl ToolTipEnabled="True" 
                            ToolTipTemplate="{StaticResource ResourceKey=tooltipTemplate}">
            <dxh:HeatmapControl.ToolTipOptions>
                <dxh:HeatmapToolTipOptions ContentMargin="0" 
                                           Pattern="X: {X}&#x0a;Y: {Y}&#x0a;Value: {V}" 
                                           OpenMode="OnHover" 
                                           AutoPopDelay="00:00:03" 
                                           InitialDelay="00:00:00.1" 
                                           CloseOnClick="False"/>
            </dxh:HeatmapControl.ToolTipOptions>
            <!--...-->
        </dxh:HeatmapControl>
    </Grid>
    

    Inheritance

    Object
    DispatcherObject
    DependencyObject
    Freezable
    DevExpress.Xpf.Charts.Heatmap.Native.NotificationElement
    HeatmapToolTipOptions
    See Also