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.
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
Initializes a new instance of the RadHeatMap class.
public RadHeatMap()Properties
Gets or sets a value indicating whether the hot tracking behavior is enabled.
public bool AllowHotTracking { get; set; }Gets or sets a value indicating whether the selection is enabled.
public bool AllowSelection { get; set; }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.
public bool AutoGenerateLegendItems { get; set; }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.
public Font CellFont { get; set; }Gets or sets the text alignment for content within data cells in the heat map visualization.
public ContentAlignment CellTextAlignment { get; set; }Gets or sets the format string used for displaying data values as text within heat map cells.
public string CellTextFormat { get; set; }Gets or sets the height in pixels of column header cells in the heat map visualization.
public int ColumnHeaderHeight { get; set; }Gets or sets the position where column headers are displayed relative to the data cells.
public ColumnHeadersPosition ColumnHeadersPosition { get; set; }Gets or sets the format string used for displaying text within column header cells.
public string ColumnHeaderTextFormat { get; set; }Gets the default size of the RadHeatMap when a new instance is initialized.
protected override Size DefaultSize { get; }Overrides:
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.
public HeatMapDefinition Definition { get; set; }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.
public string DescriptionContent { get; set; }Gets or sets a value indicating whether cell values should be rendered as text within the heat map cells.
public bool DisplayCellText { get; set; }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.
public string EmptyCellText { get; set; }Gets or sets the background color for header cells in the heat map visualization.
public Color HeaderCellBackColor { get; set; }Gets or sets the border color for header cells in the heat map visualization.
public Color HeaderCellBorderColor { get; set; }Gets or sets the border width in pixels for header cells in the heat map visualization.
public int HeaderCellBorderWidth { get; set; }Gets or sets the font used for rendering text within header cells in the heat map visualization.
public Font HeaderCellFont { get; set; }Gets or sets the text color for header cells in the heat map visualization.
public Color HeaderCellForeColor { get; set; }Gets or sets the background color for header cells when the mouse is hovering over them.
public Color HeaderCellHoverBackColor { get; set; }Gets or sets the text color for header cells when the mouse is hovering over them.
public Color HeaderCellHoverForeColor { get; set; }Gets or sets the text alignment for content within header cells in the heat map visualization.
public ContentAlignment HeaderCellTextAlignment { get; set; }Gets the main RadHeatMapElement that provides the core heat map functionality and rendering.
[Browsable(false)]
public RadHeatMapElement HeatMapElement { get; }Gets or sets the border color for data cells when the mouse is hovering over them.
public Color HoveredCellBorderColor { get; set; }Gets or sets the border width in pixels for data cells when the mouse is hovering over them.
public int HoveredCellBorderWidth { get; set; }Gets the hovered cell index.
[Browsable(false)]
public CellIndex HoveredCellIndex { get; }Gets or sets the alignment of the legend element relative to the control layout rectangle.
public LegendAlignment LegendAlignment { get; set; }Gets the legend element.
[Browsable(false)]
public HeatMapLegendElement LegendElement { get; }Gets or sets the orientation of legend items within the legend element.
public Orientation LegendOrientation { get; set; }Gets or sets the position of the legend element in the control layout rectangle.
public RadPosition LegendPosition { get; set; }Gets or sets the legend title.
public string LegendTitle { get; set; }Gets or sets the number format of legend items values.
public string LegendValueFormat { get; set; }Gets or sets the position where row headers are displayed relative to the data cells.
public RowHeadersPosition RowHeadersPosition { get; set; }Gets or sets the format string used for displaying text within row header cells.
public string RowHeaderTextFormat { get; set; }Gets or sets the width in pixels of row header cells in the heat map visualization.
public int RowHeaderWidth { get; set; }Gets or sets the RadOffice2007ScreenTipElement instance used for displaying screen tips when ToolTipDisplayMode is set to ScreenTip.
public virtual RadOffice2007ScreenTipElement ScreenTipElement { get; set; }Gets or sets the border color for data cells when they are selected in the heat map visualization.
public Color SelectedCellBorderColor { get; set; }Gets or sets the border width in pixels for data cells when they are selected in the heat map visualization.
public int SelectedCellBorderWidth { get; set; }Gets or sets the selected cell index.
[Browsable(false)]
public CellIndex SelectedCellIndex { get; set; }Gets the selected data item based on the selected cell index.
[Browsable(false)]
public HeatMapDataItem SelectedDataItem { get; }Gets or sets a value indicating whether the legend is visible and displayed in the control.
public bool ShowLegend { get; set; }Gets or sets the title text displayed above the heat map visualization.
public string Title { get; set; }Gets or sets the RadToolTip instance used for displaying tool tips when ToolTipDisplayMode is set to ToolTip.
public RadToolTip ToolTip { get; set; }Gets or sets the display mode for tool tips shown when hovering over heat map cells.
public ToolTipDisplayMode ToolTipDisplayMode { get; set; }Gets or sets a value indicating whether text should be wrapped within data cells when it exceeds the cell width.
public bool WrapCellText { get; set; }Gets or sets a value indicating whether text should be wrapped within header cells when it exceeds the cell width.
public bool WrapHeaderCellText { get; set; }Methods
Creates the child elements for the RadHeatMap control, including the main RadHeatMapElement.
protected override void CreateChildItems(RadElement parent)The parent element to which child elements will be added.
Overrides:
Creates and returns a new instance of RadHeatMapElement that provides the core functionality of the heat map.
protected virtual RadHeatMapElement CreateHeatMapElement()A new RadHeatMapElement instance.
Updates the bounds of the row, column header cells and data cells.
public void UpdateCachedBounds()Events
Occurs after a data cell in the heat map has been painted.
public event HeatMapCellPaintedEventHandler CellPaintedOccurs when a data cell in the heat map is about to be painted, allowing customization of cell appearance.
public event HeatMapCellPaitingEventHandler CellPaintingOccurs after a row or column header cell has been painted.
public event HeatMapHeaderPaintedEventHandler HeaderCellPaintedOccurs when a row or column header cell is about to be painted, allowing customization of header cell appearance.
public event HeatMapHeaderPaintingEventHandler HeaderCellPaintingOccurs 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.
public event HeatMapIndexChangedEventHandler HoveredCellIndexChangedOccurs before a screen tip is displayed, allowing customization or cancellation of the screen tip.
public event HeatMapScreenTipEventHandler ScreenTipShowingOccurs after the selected cell index has changed in the heat map.
public event HeatMapIndexChangedEventHandler SelectedCellIndexChangedOccurs before the selected cell index changes, allowing the operation to be cancelled.
public event HeatMapIndexChangingEventHandler SelectedCellIndexChangingOccurs before a tool tip is displayed, allowing customization or cancellation of the tool tip.
public event HeatMapToolTipEventHandler ToolTipShowing