ClassRadHeatMap
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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
public class RadHeatMap : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadHeatMap
Implements:
Inherited Members
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.
AllowSelection
Gets or sets a value indicating whether the selection is enabled.
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.
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.
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
CellTextFormat
Gets or sets the format string used for displaying data values as text within heat map cells.
ColumnHeaderHeight
Gets or sets the height in pixels of column header cells in the heat map visualization.
ColumnHeaderTextFormat
Gets or sets the format string used for displaying text within column header cells.
Declaration
public string ColumnHeaderTextFormat { get; set; }Property Value
ColumnHeadersPosition
Gets or sets the position where column headers are displayed relative to the data cells.
Declaration
public ColumnHeadersPosition ColumnHeadersPosition { get; set; }Property Value
DefaultSize
Gets the default size of the RadHeatMap when a new instance is initialized.
Declaration
protected override Size DefaultSize { get; }Property Value
Overrides
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
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.
DisplayCellText
Gets or sets a value indicating whether cell values should be rendered as text within the heat map cells.
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.
HeaderCellBackColor
Gets or sets the background color for header cells in the heat map visualization.
HeaderCellBorderColor
Gets or sets the border color for header cells in the heat map visualization.
HeaderCellBorderWidth
Gets or sets the border width in pixels for header cells in the heat map visualization.
HeaderCellFont
Gets or sets the font used for rendering text within header cells in the heat map visualization.
HeaderCellForeColor
Gets or sets the text color for header cells in the heat map visualization.
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
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
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
HeatMapElement
Gets the main RadHeatMapElement that provides the core heat map functionality and rendering.
Declaration
[Browsable(false)]
public RadHeatMapElement HeatMapElement { get; }Property Value
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
HoveredCellBorderWidth
Gets or sets the border width in pixels for data cells when the mouse is hovering over them.
HoveredCellIndex
Gets the hovered cell index.
Declaration
[Browsable(false)]
public CellIndex HoveredCellIndex { get; }Property Value
LegendAlignment
Gets or sets the alignment of the legend element relative to the control layout rectangle.
Declaration
public LegendAlignment LegendAlignment { get; set; }Property Value
LegendElement
Gets the legend element.
Declaration
[Browsable(false)]
public HeatMapLegendElement LegendElement { get; }Property Value
LegendOrientation
Gets or sets the orientation of legend items within the legend element.
Declaration
public Orientation LegendOrientation { get; set; }Property Value
LegendPosition
Gets or sets the position of the legend element in the control layout rectangle.
Declaration
public RadPosition LegendPosition { get; set; }Property Value
LegendTitle
Gets or sets the legend title.
LegendValueFormat
Gets or sets the number format of legend items values.
RowHeaderTextFormat
Gets or sets the format string used for displaying text within row header cells.
RowHeaderWidth
Gets or sets the width in pixels of row header cells in the heat map visualization.
RowHeadersPosition
Gets or sets the position where row headers are displayed relative to the data cells.
Declaration
public RowHeadersPosition RowHeadersPosition { get; set; }Property Value
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
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
SelectedCellBorderWidth
Gets or sets the border width in pixels for data cells when they are selected in the heat map visualization.
SelectedCellIndex
Gets or sets the selected cell index.
Declaration
[Browsable(false)]
public CellIndex SelectedCellIndex { get; set; }Property Value
SelectedDataItem
Gets the selected data item based on the selected cell index.
Declaration
[Browsable(false)]
public HeatMapDataItem SelectedDataItem { get; }Property Value
ShowLegend
Gets or sets a value indicating whether the legend is visible and displayed in the control.
Title
Gets or sets the title text displayed above the heat map visualization.
ToolTip
Gets or sets the RadToolTip instance used for displaying tool tips when ToolTipDisplayMode is set to ToolTip.
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
WrapCellText
Gets or sets a value indicating whether text should be wrapped within data cells when it exceeds the cell width.
WrapHeaderCellText
Gets or sets a value indicating whether text should be wrapped within header cells when it exceeds the cell width.
Methods
CreateChildItems(RadElement)
Creates the child elements for the RadHeatMap control, including the main RadHeatMapElement.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
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
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 CellPaintedEvent Value
CellPainting
Occurs when a data cell in the heat map is about to be painted, allowing customization of cell appearance.
Declaration
public event HeatMapCellPaitingEventHandler CellPaintingEvent Value
HeaderCellPainted
Occurs after a row or column header cell has been painted.
Declaration
public event HeatMapHeaderPaintedEventHandler HeaderCellPaintedEvent Value
HeaderCellPainting
Occurs when a row or column header cell is about to be painted, allowing customization of header cell appearance.
Declaration
public event HeatMapHeaderPaintingEventHandler HeaderCellPaintingEvent Value
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 HoveredCellIndexChangedEvent Value
ScreenTipShowing
Occurs before a screen tip is displayed, allowing customization or cancellation of the screen tip.
Declaration
public event HeatMapScreenTipEventHandler ScreenTipShowingEvent Value
SelectedCellIndexChanged
Occurs after the selected cell index has changed in the heat map.
Declaration
public event HeatMapIndexChangedEventHandler SelectedCellIndexChangedEvent Value
SelectedCellIndexChanging
Occurs before the selected cell index changes, allowing the operation to be cancelled.
Declaration
public event HeatMapIndexChangingEventHandler SelectedCellIndexChangingEvent Value
ToolTipShowing
Occurs before a tool tip is displayed, allowing customization or cancellation of the tool tip.
Declaration
public event HeatMapToolTipEventHandler ToolTipShowingEvent Value