Class RadHeatMap

Represents a data visualization control that displays values in a tabular format using color-coded cells. The data is organized in rows and columns where each cell's color corresponds to its value, generated by a HeatMapColorizer. Requires a valid HeatMapDefinition to properly plot the cells and generate appropriate colors.

Inheritance
System.Object
RadControl
RadHeatMap
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadHeatMap : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadHeatMap()

Initializes a new instance of the RadHeatMap class.

Declaration
public RadHeatMap()

Properties

AllowHotTracking

Gets or sets a value indicating whether the hot tracking behavior is enabled.

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

AllowSelection

Gets or sets a value indicating whether the selection is enabled.

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

AutoGenerateLegendItems

Gets or sets a value indicating whether legend items are automatically generated from the heat map data. When true, legend items are created automatically when ShowLegend is enabled, and VisualItemCreating is fired for each item. When false, legend items must be added programmatically by the developer.

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

AutoSize

This property is not relevant for this class.

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

Overrides

CellFont

Gets or sets the font used for rendering text within data cells in the heat map visualization. This property is inheritable through the element tree.

Declaration
public Font CellFont { get; set; }
Property Value
System.Drawing.Font

CellTextAlignment

Gets or sets the text alignment for content within data cells in the heat map visualization.

Declaration
public ContentAlignment CellTextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

CellTextFormat

Gets or sets the format string used for displaying data values as text within heat map cells.

Declaration
public string CellTextFormat { get; set; }
Property Value
System.String

ColumnHeaderHeight

Gets or sets the height in pixels of column header cells in the heat map visualization.

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

ColumnHeadersPosition

Gets or sets the position where column headers are displayed relative to the data cells.

Declaration
public ColumnHeadersPosition ColumnHeadersPosition { get; set; }
Property Value
ColumnHeadersPosition

ColumnHeaderTextFormat

Gets or sets the format string used for displaying text within column header cells.

Declaration
public string ColumnHeaderTextFormat { get; set; }
Property Value
System.String

DefaultSize

Gets the default size of the RadHeatMap when a new instance is initialized.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Definition

Gets or sets the HeatMapDefinition that manages the data source and defines how data is organized into rows and columns. This property is essential for the heat map to function correctly.

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

DescriptionContent

Gets or sets the content of the description cell located in the corner between row and column header cells. Note that the description is not shown if row or column headers are hidden.

Declaration
public string DescriptionContent { get; set; }
Property Value
System.String

DisplayCellText

Gets or sets a value indicating whether cell values should be rendered as text within the heat map cells.

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

EmptyCellText

Gets or sets the text content displayed in cells that contain no data or null values. This text is also used as the tool tip text for empty cells.

Declaration
public string EmptyCellText { get; set; }
Property Value
System.String

HeaderCellBackColor

Gets or sets the background color for header cells in the heat map visualization.

Declaration
public Color HeaderCellBackColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellBorderColor

Gets or sets the border color for header cells in the heat map visualization.

Declaration
public Color HeaderCellBorderColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellBorderWidth

Gets or sets the border width in pixels for header cells in the heat map visualization.

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

HeaderCellFont

Gets or sets the font used for rendering text within header cells in the heat map visualization.

Declaration
public Font HeaderCellFont { get; set; }
Property Value
System.Drawing.Font

HeaderCellForeColor

Gets or sets the text color for header cells in the heat map visualization.

Declaration
public Color HeaderCellForeColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellHoverBackColor

Gets or sets the background color for header cells when the mouse is hovering over them.

Declaration
public Color HeaderCellHoverBackColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellHoverForeColor

Gets or sets the text color for header cells when the mouse is hovering over them.

Declaration
public Color HeaderCellHoverForeColor { get; set; }
Property Value
System.Drawing.Color

HeaderCellTextAlignment

Gets or sets the text alignment for content within header cells in the heat map visualization.

Declaration
public ContentAlignment HeaderCellTextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

HeatMapElement

Gets the main RadHeatMapElement that provides the core heat map functionality and rendering.

Declaration
public RadHeatMapElement HeatMapElement { get; }
Property Value
RadHeatMapElement

HoveredCellBorderColor

Gets or sets the border color for data cells when the mouse is hovering over them.

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

HoveredCellBorderWidth

Gets or sets the border width in pixels for data cells when the mouse is hovering over them.

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

HoveredCellIndex

Gets the hovered cell index.

Declaration
public CellIndex HoveredCellIndex { get; }
Property Value
CellIndex

LegendAlignment

Gets or sets the alignment of the legend element relative to the control layout rectangle.

Declaration
public LegendAlignment LegendAlignment { get; set; }
Property Value
LegendAlignment

LegendElement

Gets the legend element.

Declaration
public HeatMapLegendElement LegendElement { get; }
Property Value
HeatMapLegendElement

LegendOrientation

Gets or sets the orientation of legend items within the legend element.

Declaration
public Orientation LegendOrientation { get; set; }
Property Value
System.Windows.Forms.Orientation

LegendPosition

Gets or sets the position of the legend element in the control layout rectangle.

Declaration
public RadPosition LegendPosition { get; set; }
Property Value
RadPosition

LegendTitle

Gets or sets the legend title.

Declaration
public string LegendTitle { get; set; }
Property Value
System.String

LegendValueFormat

Gets or sets the number format of legend items values.

Declaration
public string LegendValueFormat { get; set; }
Property Value
System.String

RowHeadersPosition

Gets or sets the position where row headers are displayed relative to the data cells.

Declaration
public RowHeadersPosition RowHeadersPosition { get; set; }
Property Value
RowHeadersPosition

RowHeaderTextFormat

Gets or sets the format string used for displaying text within row header cells.

Declaration
public string RowHeaderTextFormat { get; set; }
Property Value
System.String

RowHeaderWidth

Gets or sets the width in pixels of row header cells in the heat map visualization.

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

ScreenTipElement

Gets or sets the RadOffice2007ScreenTipElement instance used for displaying screen tips when ToolTipDisplayMode is set to ScreenTip.

Declaration
public virtual RadOffice2007ScreenTipElement ScreenTipElement { get; set; }
Property Value
RadOffice2007ScreenTipElement

SelectedCellBorderColor

Gets or sets the border color for data cells when they are selected in the heat map visualization.

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

SelectedCellBorderWidth

Gets or sets the border width in pixels for data cells when they are selected in the heat map visualization.

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

SelectedCellIndex

Gets or sets the selected cell index.

Declaration
public CellIndex SelectedCellIndex { get; set; }
Property Value
CellIndex

SelectedDataItem

Gets the selected data item based on the selected cell index.

Declaration
public HeatMapDataItem SelectedDataItem { get; }
Property Value
HeatMapDataItem

ShowLegend

Gets or sets a value indicating whether the legend is visible and displayed in the control.

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

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Title

Gets or sets the title text displayed above the heat map visualization.

Declaration
public string Title { get; set; }
Property Value
System.String

ToolTip

Gets or sets the RadToolTip instance used for displaying tool tips when ToolTipDisplayMode is set to ToolTip.

Declaration
public RadToolTip ToolTip { get; set; }
Property Value
RadToolTip

ToolTipDisplayMode

Gets or sets the display mode for tool tips shown when hovering over heat map cells.

Declaration
public ToolTipDisplayMode ToolTipDisplayMode { get; set; }
Property Value
ToolTipDisplayMode

WrapCellText

Gets or sets a value indicating whether text should be wrapped within data cells when it exceeds the cell width.

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

WrapHeaderCellText

Gets or sets a value indicating whether text should be wrapped within header cells when it exceeds the cell width.

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

Methods

CreateChildItems(RadElement)

Creates the child elements for the RadHeatMap control, including the main RadHeatMapElement.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which child elements will be added.
Overrides

CreateHeatMapElement()

Creates and returns a new instance of RadHeatMapElement that provides the core functionality of the heat map.

Declaration
protected virtual RadHeatMapElement CreateHeatMapElement()
Returns
RadHeatMapElement

A new RadHeatMapElement instance.

UpdateCachedBounds()

Updates the bounds of the row, column header cells and data cells.

Declaration
public void UpdateCachedBounds()

Events

CellPainted

Occurs after a data cell in the heat map has been painted.

Declaration
public event HeatMapCellPaintedEventHandler CellPainted
Event Type
HeatMapCellPaintedEventHandler

CellPainting

Occurs when a data cell in the heat map is about to be painted, allowing customization of cell appearance.

Declaration
public event HeatMapCellPaitingEventHandler CellPainting
Event Type
HeatMapCellPaitingEventHandler

HeaderCellPainted

Occurs after a row or column header cell has been painted.

Declaration
public event HeatMapHeaderPaintedEventHandler HeaderCellPainted
Event Type
HeatMapHeaderPaintedEventHandler

HeaderCellPainting

Occurs when a row or column header cell is about to be painted, allowing customization of header cell appearance.

Declaration
public event HeatMapHeaderPaintingEventHandler HeaderCellPainting
Event Type
HeatMapHeaderPaintingEventHandler

HoveredCellIndexChanged

Occurs when the hovered cell index changes during mouse movement over the heat map. For column header cells, RowIndex will be -1. For row header cells, ColumnIndex will be -1.

Declaration
public event HeatMapIndexChangedEventHandler HoveredCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

ScreenTipNeeded

This event is not relevant for this class.

Declaration
public override event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
ScreenTipNeededEventHandler

Overrides

ScreenTipShowing

Occurs before a screen tip is displayed, allowing customization or cancellation of the screen tip.

Declaration
public event HeatMapScreenTipEventHandler ScreenTipShowing
Event Type
HeatMapScreenTipEventHandler

SelectedCellIndexChanged

Occurs after the selected cell index has changed in the heat map.

Declaration
public event HeatMapIndexChangedEventHandler SelectedCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

SelectedCellIndexChanging

Occurs before the selected cell index changes, allowing the operation to be cancelled.

Declaration
public event HeatMapIndexChangingEventHandler SelectedCellIndexChanging
Event Type
HeatMapIndexChangingEventHandler

ToolTipShowing

Occurs before a tool tip is displayed, allowing customization or cancellation of the tool tip.

Declaration
public event HeatMapToolTipEventHandler ToolTipShowing
Event Type
HeatMapToolTipEventHandler

ToolTipTextNeeded

This event is not relevant for this class.

Declaration
public override event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Overrides

Extension Methods