Back to all docs
API Reference / Telerik.Windows.Controls / RadHeatMap

Class
RadHeatMap

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:
cs-api-definition
[TelerikToolboxCategory("Data Visualization")]
public sealed class RadHeatMap : Control

Inheritance: objectRadHeatMap

Constructors

RadHeatMap()

Initializes a new instance of the RadHeatMap class.

Declaration

cs-api-definition
public RadHeatMap()

Fields

CellBorderColorProperty

Identifies the CellBorderColor dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CellBorderColorProperty

Field Value

DependencyProperty

CellBorderThicknessProperty

Identifies the CellBorderThickness dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CellBorderThicknessProperty

Field Value

DependencyProperty

CellLabelSettingsProperty

Identifies the CellLabelSettings dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CellLabelSettingsProperty

Field Value

DependencyProperty

ColumnHeaderSettingsProperty

Identifies the ColumnHeaderSettings dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ColumnHeaderSettingsProperty

Field Value

DependencyProperty

ColumnHeadersProperty

Identifies the ColumnHeaders dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ColumnHeadersProperty

Field Value

DependencyProperty

ColumnsCountProperty

Identifies the ColumnsCount dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ColumnsCountProperty

Field Value

DependencyProperty

DefinitionProperty

Identifies the Definition dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DefinitionProperty

Field Value

DependencyProperty

DescriptionContentProperty

Identifies the DescriptionContent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionContentProperty

Field Value

DependencyProperty

HoveredCellBorderColorProperty

Identifies the HoveredCellBorderColor dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HoveredCellBorderColorProperty

Field Value

DependencyProperty

HoveredCellBorderThicknessProperty

Identifies the HoveredCellBorderThickness dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HoveredCellBorderThicknessProperty

Field Value

DependencyProperty

HoveredCellDataPointProperty

Identifies the HoveredCellDataPoint dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty HoveredCellDataPointProperty

Field Value

DependencyProperty

RowHeaderSettingsProperty

Identifies the RowHeaderSettings dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty RowHeaderSettingsProperty

Field Value

DependencyProperty

RowHeadersProperty

Identifies the RowHeaders dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty RowHeadersProperty

Field Value

DependencyProperty

RowsCountProperty

Identifies the RowsCount dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty RowsCountProperty

Field Value

DependencyProperty

SelectedCellBorderColorProperty

Identifies the SelectedCellBorderColor dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedCellBorderColorProperty

Field Value

DependencyProperty

SelectedCellBorderThicknessProperty

Identifies the SelectedCellBorderThickness dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectedCellBorderThicknessProperty

Field Value

DependencyProperty

SelectionModeProperty

Identifies the SelectionMode dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SelectionModeProperty

Field Value

DependencyProperty

ShowToolTipsProperty

Identifies the ShowToolTips dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ShowToolTipsProperty

Field Value

DependencyProperty

ToolTipSettingsProperty

Identifies the ToolTipSettings dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ToolTipSettingsProperty

Field Value

DependencyProperty

Properties

CellBorderColor

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

Declaration

cs-api-definition
public Color CellBorderColor { get; set; }

Property Value

Color

CellBorderThickness

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

Declaration

cs-api-definition
public int CellBorderThickness { get; set; }

Property Value

int

CellLabelSettings

Gets or sets the cell-label settings.

Declaration

cs-api-definition
public HeatMapCellLabelSettings CellLabelSettings { get; set; }

Property Value

HeatMapCellLabelSettings

ColumnHeaderSettings

Gets or sets the column-header settings.

Declaration

cs-api-definition
public HeatMapColumnHeaderSettings ColumnHeaderSettings { get; set; }

Property Value

HeatMapColumnHeaderSettings

ColumnHeaders

Gets the column headers.

Declaration

cs-api-definition
public IList<HeatMapLabelInfo> ColumnHeaders { get; }

Property Value

IList<HeatMapLabelInfo>

ColumnsCount

Gets the number of columns.

Declaration

cs-api-definition
public int ColumnsCount { get; }

Property Value

int

Definition

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

Declaration

cs-api-definition
public HeatMapDefinition Definition { get; set; }

Property Value

HeatMapDefinition

DescriptionContent

Gets or sets the description.

Declaration

cs-api-definition
public object DescriptionContent { get; set; }

Property Value

object

HoveredCellBorderColor

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

Declaration

cs-api-definition
public Color HoveredCellBorderColor { get; set; }

Property Value

Color

HoveredCellBorderThickness

Gets or sets the border thickness of the hovered cell.

Declaration

cs-api-definition
public int HoveredCellBorderThickness { get; set; }

Property Value

int

HoveredCellDataPoint

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

Declaration

cs-api-definition
public HeatMapCellDataPoint HoveredCellDataPoint { get; set; }

Property Value

HeatMapCellDataPoint

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.

RowHeaderSettings

Gets or sets the row-header settings.

Declaration

cs-api-definition
public HeatMapRowHeaderSettings RowHeaderSettings { get; set; }

Property Value

HeatMapRowHeaderSettings

RowHeaders

Gets the row headers.

Declaration

cs-api-definition
public IList<HeatMapLabelInfo> RowHeaders { get; }

Property Value

IList<HeatMapLabelInfo>

RowsCount

Gets the number of rows.

Declaration

cs-api-definition
public int RowsCount { get; }

Property Value

int

SelectedCellBorderColor

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

Declaration

cs-api-definition
public Color SelectedCellBorderColor { get; set; }

Property Value

Color

SelectedCellBorderThickness

Gets or sets the border thickness of the selected cell.

Declaration

cs-api-definition
public int SelectedCellBorderThickness { get; set; }

Property Value

int

SelectionMode

Gets or sets the selection mode.

Declaration

cs-api-definition
public HeatMapSelectionMode SelectionMode { get; set; }

Property Value

HeatMapSelectionMode

ShowToolTips

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

Declaration

cs-api-definition
public bool ShowToolTips { get; set; }

Property Value

bool

ToolTipSettings

Gets or sets the tool tip settings.

Declaration

cs-api-definition
public HeatMapToolTipSettings ToolTipSettings { get; set; }

Property Value

HeatMapToolTipSettings

Methods

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

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.

Declaration

cs-api-definition
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)

Parameters

e

MouseButtonEventArgs

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

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