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.

Inheritance
System.Object
RadHeatMap
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

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

Constructors

RadHeatMap()

Initializes a new instance of the RadHeatMap class.

Declaration
public RadHeatMap()

Fields

CellBorderColorProperty

Identifies the CellBorderColor dependency property.

Declaration
public static readonly DependencyProperty CellBorderColorProperty
Field Value
System.Windows.DependencyProperty

CellBorderThicknessProperty

Identifies the CellBorderThickness dependency property.

Declaration
public static readonly DependencyProperty CellBorderThicknessProperty
Field Value
System.Windows.DependencyProperty

CellLabelSettingsProperty

Identifies the CellLabelSettings dependency property.

Declaration
public static readonly DependencyProperty CellLabelSettingsProperty
Field Value
System.Windows.DependencyProperty

ColumnHeaderSettingsProperty

Identifies the ColumnHeaderSettings dependency property.

Declaration
public static readonly DependencyProperty ColumnHeaderSettingsProperty
Field Value
System.Windows.DependencyProperty

ColumnHeadersProperty

Identifies the ColumnHeaders dependency property.

Declaration
public static readonly DependencyProperty ColumnHeadersProperty
Field Value
System.Windows.DependencyProperty

ColumnsCountProperty

Identifies the ColumnsCount dependency property.

Declaration
public static readonly DependencyProperty ColumnsCountProperty
Field Value
System.Windows.DependencyProperty

DefinitionProperty

Identifies the Definition dependency property.

Declaration
public static readonly DependencyProperty DefinitionProperty
Field Value
System.Windows.DependencyProperty

DescriptionContentProperty

Identifies the DescriptionContent dependency property.

Declaration
public static readonly DependencyProperty DescriptionContentProperty
Field Value
System.Windows.DependencyProperty

HoveredCellBorderColorProperty

Identifies the HoveredCellBorderColor dependency property.

Declaration
public static readonly DependencyProperty HoveredCellBorderColorProperty
Field Value
System.Windows.DependencyProperty

HoveredCellBorderThicknessProperty

Identifies the HoveredCellBorderThickness dependency property.

Declaration
public static readonly DependencyProperty HoveredCellBorderThicknessProperty
Field Value
System.Windows.DependencyProperty

HoveredCellDataPointProperty

Identifies the HoveredCellDataPoint dependency property.

Declaration
public static readonly DependencyProperty HoveredCellDataPointProperty
Field Value
System.Windows.DependencyProperty

RowHeaderSettingsProperty

Identifies the RowHeaderSettings dependency property.

Declaration
public static readonly DependencyProperty RowHeaderSettingsProperty
Field Value
System.Windows.DependencyProperty

RowHeadersProperty

Identifies the RowHeaders dependency property.

Declaration
public static readonly DependencyProperty RowHeadersProperty
Field Value
System.Windows.DependencyProperty

RowsCountProperty

Identifies the RowsCount dependency property.

Declaration
public static readonly DependencyProperty RowsCountProperty
Field Value
System.Windows.DependencyProperty

SelectedCellBorderColorProperty

Identifies the SelectedCellBorderColor dependency property.

Declaration
public static readonly DependencyProperty SelectedCellBorderColorProperty
Field Value
System.Windows.DependencyProperty

SelectedCellBorderThicknessProperty

Identifies the SelectedCellBorderThickness dependency property.

Declaration
public static readonly DependencyProperty SelectedCellBorderThicknessProperty
Field Value
System.Windows.DependencyProperty

SelectionModeProperty

Identifies the SelectionMode dependency property.

Declaration
public static readonly DependencyProperty SelectionModeProperty
Field Value
System.Windows.DependencyProperty

ShowToolTipsProperty

Identifies the ShowToolTips dependency property.

Declaration
public static readonly DependencyProperty ShowToolTipsProperty
Field Value
System.Windows.DependencyProperty

ToolTipSettingsProperty

Identifies the ToolTipSettings dependency property.

Declaration
public static readonly DependencyProperty ToolTipSettingsProperty
Field Value
System.Windows.DependencyProperty

Properties

CellBorderColor

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

Declaration
public Color CellBorderColor { get; set; }
Property Value
System.Windows.Media.Color

CellBorderThickness

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

Declaration
public int CellBorderThickness { get; set; }
Property Value
System.Int32

CellLabelSettings

Gets or sets the cell-label settings.

Declaration
public HeatMapCellLabelSettings CellLabelSettings { get; set; }
Property Value
HeatMapCellLabelSettings

ColumnHeaders

Gets the column headers.

Declaration
public IList<HeatMapLabelInfo> ColumnHeaders { get; }
Property Value
System.Collections.Generic.IList<HeatMapLabelInfo>

ColumnHeaderSettings

Gets or sets the column-header settings.

Declaration
public HeatMapColumnHeaderSettings ColumnHeaderSettings { get; set; }
Property Value
HeatMapColumnHeaderSettings

ColumnsCount

Gets the number of columns.

Declaration
public int ColumnsCount { get; }
Property Value
System.Int32

Definition

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

Declaration
public HeatMapDefinition Definition { get; set; }
Property Value
HeatMapDefinition

DescriptionContent

Gets or sets the description.

Declaration
public object DescriptionContent { get; set; }
Property Value
System.Object

HoveredCellBorderColor

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

Declaration
public Color HoveredCellBorderColor { get; set; }
Property Value
System.Windows.Media.Color

HoveredCellBorderThickness

Gets or sets the border thickness of the hovered cell.

Declaration
public int HoveredCellBorderThickness { get; set; }
Property Value
System.Int32

HoveredCellDataPoint

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

Declaration
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.

RowHeaders

Gets the row headers.

Declaration
public IList<HeatMapLabelInfo> RowHeaders { get; }
Property Value
System.Collections.Generic.IList<HeatMapLabelInfo>

RowHeaderSettings

Gets or sets the row-header settings.

Declaration
public HeatMapRowHeaderSettings RowHeaderSettings { get; set; }
Property Value
HeatMapRowHeaderSettings

RowsCount

Gets the number of rows.

Declaration
public int RowsCount { get; }
Property Value
System.Int32

SelectedCellBorderColor

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

Declaration
public Color SelectedCellBorderColor { get; set; }
Property Value
System.Windows.Media.Color

SelectedCellBorderThickness

Gets or sets the border thickness of the selected cell.

Declaration
public int SelectedCellBorderThickness { get; set; }
Property Value
System.Int32

SelectionMode

Gets or sets the selection mode.

Declaration
public HeatMapSelectionMode SelectionMode { get; set; }
Property Value
HeatMapSelectionMode

ShowToolTips

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

Declaration
public bool ShowToolTips { get; set; }
Property Value
System.Boolean

ToolTipSettings

Gets or sets the tool tip settings.

Declaration
public HeatMapToolTipSettings ToolTipSettings { get; set; }
Property Value
HeatMapToolTipSettings

Methods

OnCreateAutomationPeer()

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

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

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

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

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

Extension Methods