Back to all docs
API Reference / Telerik.Windows.Controls / RadHeatMap
New to Telerik UI for WPF? Start a free 30-day trial

RadHeatMap

Class

A data visualization control that represents values in a tabular display. The data is displayed in cells, aligned in rows and columns and each cell has a color that corresponds to the value of the cell. The color of the cell is generated by a HeatMapColorizer. The RadHeatMap needs a valid HeatMapDefinition in order to plot the cells and colors correctly.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:
C#
[TelerikToolboxCategory("Data Visualization")]
public sealed class RadHeatMap : Control

Inheritance: objectRadHeatMap

Constructors

RadHeatMap()

Initializes a new instance of the RadHeatMap class.

C#
public RadHeatMap()

Fields

CellBorderColorProperty

DependencyProperty

Identifies the CellBorderColor dependency property.

C#
public static readonly DependencyProperty CellBorderColorProperty

CellBorderThicknessProperty

DependencyProperty

Identifies the CellBorderThickness dependency property.

C#
public static readonly DependencyProperty CellBorderThicknessProperty

CellLabelSettingsProperty

DependencyProperty

Identifies the CellLabelSettings dependency property.

C#
public static readonly DependencyProperty CellLabelSettingsProperty

ColumnHeaderSettingsProperty

DependencyProperty

Identifies the ColumnHeaderSettings dependency property.

C#
public static readonly DependencyProperty ColumnHeaderSettingsProperty

ColumnHeadersProperty

DependencyProperty

Identifies the ColumnHeaders dependency property.

C#
public static readonly DependencyProperty ColumnHeadersProperty

ColumnsCountProperty

DependencyProperty

Identifies the ColumnsCount dependency property.

C#
public static readonly DependencyProperty ColumnsCountProperty

DefinitionProperty

DependencyProperty

Identifies the Definition dependency property.

C#
public static readonly DependencyProperty DefinitionProperty

DescriptionContentProperty

DependencyProperty

Identifies the DescriptionContent dependency property.

C#
public static readonly DependencyProperty DescriptionContentProperty

HoveredCellBorderColorProperty

DependencyProperty

Identifies the HoveredCellBorderColor dependency property.

C#
public static readonly DependencyProperty HoveredCellBorderColorProperty

HoveredCellBorderThicknessProperty

DependencyProperty

Identifies the HoveredCellBorderThickness dependency property.

C#
public static readonly DependencyProperty HoveredCellBorderThicknessProperty

HoveredCellDataPointProperty

DependencyProperty

Identifies the HoveredCellDataPoint dependency property.

C#
public static readonly DependencyProperty HoveredCellDataPointProperty

RowHeaderSettingsProperty

DependencyProperty

Identifies the RowHeaderSettings dependency property.

C#
public static readonly DependencyProperty RowHeaderSettingsProperty

RowHeadersProperty

DependencyProperty

Identifies the RowHeaders dependency property.

C#
public static readonly DependencyProperty RowHeadersProperty

RowsCountProperty

DependencyProperty

Identifies the RowsCount dependency property.

C#
public static readonly DependencyProperty RowsCountProperty

SelectedCellBorderColorProperty

DependencyProperty

Identifies the SelectedCellBorderColor dependency property.

C#
public static readonly DependencyProperty SelectedCellBorderColorProperty

SelectedCellBorderThicknessProperty

DependencyProperty

Identifies the SelectedCellBorderThickness dependency property.

C#
public static readonly DependencyProperty SelectedCellBorderThicknessProperty

SelectionModeProperty

DependencyProperty

Identifies the SelectionMode dependency property.

C#
public static readonly DependencyProperty SelectionModeProperty

ShowToolTipsProperty

DependencyProperty

Identifies the ShowToolTips dependency property.

C#
public static readonly DependencyProperty ShowToolTipsProperty

ToolTipSettingsProperty

DependencyProperty

Identifies the ToolTipSettings dependency property.

C#
public static readonly DependencyProperty ToolTipSettingsProperty

Properties

CellBorderColor

Color

Gets or sets the color of the border of the hovered cell.

C#
public Color CellBorderColor { get; set; }

CellBorderThickness

Gets or sets the thickness of the border of a cell.

C#
public int CellBorderThickness { get; set; }

CellLabelSettings

Gets or sets the cell-label settings.

C#
public HeatMapCellLabelSettings CellLabelSettings { get; set; }

ColumnHeaders

Gets the column headers.

C#
public IList<HeatMapLabelInfo> ColumnHeaders { get; }

ColumnHeaderSettings

Gets or sets the column-header settings.

C#
public HeatMapColumnHeaderSettings ColumnHeaderSettings { get; set; }

ColumnsCount

Gets the number of columns.

C#
public int ColumnsCount { get; }

Definition

Gets or sets the definition. The definition is used to extract the row-headers, column-headers and cell colors.

C#
public HeatMapDefinition Definition { get; set; }

DescriptionContent

Gets or sets the description.

C#
public object DescriptionContent { get; set; }

HoveredCellBorderColor

Color

Gets or sets the color of the border of the hovered cell.

C#
public Color HoveredCellBorderColor { get; set; }

HoveredCellBorderThickness

Gets or sets the border thickness of the hovered cell.

C#
public int HoveredCellBorderThickness { get; set; }

HoveredCellDataPoint

Gets the data point which corresponds to the currently hovered cell.

C#
public HeatMapCellDataPoint HoveredCellDataPoint { get; set; }
Property Value:

The data point that contains information about the cell that the mouse is over. If the mouse is not over the HeatMapColorGrid, the value of this property is null.

RowHeaders

Gets the row headers.

C#
public IList<HeatMapLabelInfo> RowHeaders { get; }

RowHeaderSettings

Gets or sets the row-header settings.

C#
public HeatMapRowHeaderSettings RowHeaderSettings { get; set; }

RowsCount

Gets the number of rows.

C#
public int RowsCount { get; }

SelectedCellBorderColor

Color

Gets or sets the color of the border of the selected cell.

C#
public Color SelectedCellBorderColor { get; set; }

SelectedCellBorderThickness

Gets or sets the border thickness of the selected cell.

C#
public int SelectedCellBorderThickness { get; set; }

SelectionMode

Gets or sets the selection mode.

C#
public HeatMapSelectionMode SelectionMode { get; set; }

ShowToolTips

Gets or sets a value indicating whether tool tips should be shown.

C#
public bool ShowToolTips { get; set; }

ToolTipSettings

Gets or sets the tool tip settings.

C#
public HeatMapToolTipSettings ToolTipSettings { get; set; }

Methods

OnCreateAutomationPeer()

AutomationPeer

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled  routed event is raised on this element. Implement this method to add class handling for this event.

C#
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters:eMouseButtonEventArgs

The MouseButtonEventArgs that contains the event data. The event data reports that the left mouse button was pressed.

In this article
DefinitionConstructorsRadHeatMap()FieldsCellBorderColorPropertyCellBorderThicknessPropertyCellLabelSettingsPropertyColumnHeaderSettingsPropertyColumnHeadersPropertyColumnsCountPropertyDefinitionPropertyDescriptionContentPropertyHoveredCellBorderColorPropertyHoveredCellBorderThicknessPropertyHoveredCellDataPointPropertyRowHeaderSettingsPropertyRowHeadersPropertyRowsCountPropertySelectedCellBorderColorPropertySelectedCellBorderThicknessPropertySelectionModePropertyShowToolTipsPropertyToolTipSettingsPropertyPropertiesCellBorderColorCellBorderThicknessCellLabelSettingsColumnHeadersColumnHeaderSettingsColumnsCountDefinitionDescriptionContentHoveredCellBorderColorHoveredCellBorderThicknessHoveredCellDataPointRowHeadersRowHeaderSettingsRowsCountSelectedCellBorderColorSelectedCellBorderThicknessSelectionModeShowToolTipsToolTipSettingsMethodsOnCreateAutomationPeer()OnInitialized(EventArgs)OnMouseLeftButtonDown(MouseButtonEventArgs)
Not finding the help you need?
Contact Support