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
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 to generate legend items automatically. If true the legend items are automatically created when ShowLegend is set to true. The VisualItemCreating is fired for each created item. If false, the legend items are not created and the developer adds them programmatically.

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

The font used for cells. Font - ex. of the text of an element. The 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 of the cells.

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

CellTextFormat

Gets or sets the cell text format string.

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

ColumnHeaderHeight

Gets or sets the height of column headers.

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

ColumnHeadersPosition

Gets or sets the position of the column headers.

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

ColumnHeaderTextFormat

Gets or sets the column header cell text format string.

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 heat map definition. The definition is responsible for managing the data and displaying the data in rows and columns.

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 to paint the cell values.

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

EmptyCellText

Gets or sets the text and tool tip text shown in empty cells(with no data or null values).

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

HeaderCellBackColor

Gets or sets the header background color.

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

HeaderCellBorderColor

Gets or sets the header border color.

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

HeaderCellBorderWidth

Gets or sets the header border width.

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

HeaderCellFont

The font used for header cells.

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

HeaderCellForeColor

Gets or sets the header cell foreground color.

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

HeaderCellHoverBackColor

Gets or sets the header cell mouse over background color.

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

HeaderCellHoverForeColor

Gets or sets the header cell mouse over foreground color.

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

HeaderCellTextAlignment

Gets or sets the text alignment in the header cells.

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

HeatMapElement

Declaration
public RadHeatMapElement HeatMapElement { get; }
Property Value
RadHeatMapElement

HoveredCellBorderColor

Gets or sets the hovered cell border color.

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

HoveredCellBorderWidth

Gets or sets the hovered cell border width.

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 the legend items.

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 of the row headers.

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

RowHeaderTextFormat

Gets or sets the row header cell text format string.

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

RowHeaderWidth

Gets or sets the width of row headers.

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

ScreenTipElement

Gets or sets the screen tip element. It is displayed when the ToolTipDisplayMode is ScreenTip.

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

SelectedCellBorderColor

Gets or sets the selected cell border color.

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

SelectedCellBorderWidth

Gets or sets the border width of selected cell.

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 legend is shown.

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 heat map title.

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

ToolTip

Gets or sets the tool tip. It is displayed when the ToolTipDisplayMode is ToolTip.

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

ToolTipDisplayMode

Gets or sets a value indicating how to display tool tips.

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

WrapCellText

Gets or sets a value indicating whether to wrap the text of the cells.

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

WrapHeaderCellText

Gets or sets a value indicating whether to wrap the text of row and column header cells.

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

Methods

CreateChildItems(RadElement)

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

Overrides

CreateHeatMapElement()

Declaration
protected virtual RadHeatMapElement CreateHeatMapElement()
Returns
RadHeatMapElement

UpdateCachedBounds()

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

Declaration
public void UpdateCachedBounds()

Events

CellPainted

Occurs when a cell has been painted.

Declaration
public event HeatMapCellPaintedEventHandler CellPainted
Event Type
HeatMapCellPaintedEventHandler

CellPainting

Occurs when a cell is about to be painted.

Declaration
public event HeatMapCellPaitingEventHandler CellPainting
Event Type
HeatMapCellPaitingEventHandler

HeaderCellPainted

Occurs when a row/column header cell has been painted.

Declaration
public event HeatMapHeaderPaintedEventHandler HeaderCellPainted
Event Type
HeatMapHeaderPaintedEventHandler

HeaderCellPainting

Occurs when a row/column header cell is about to be painted.

Declaration
public event HeatMapHeaderPaintingEventHandler HeaderCellPainting
Event Type
HeatMapHeaderPaintingEventHandler

HoveredCellIndexChanged

Occurs when the hovered cell index has changed. For column header cells the RowIndex is -1. For row header cells the ColumnIndex is -1.

Declaration
public event HeatMapIndexChangedEventHandler HoveredCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

ScreenTipNeeded

Declaration
public override event ScreenTipNeededEventHandler ScreenTipNeeded
Event Type
ScreenTipNeededEventHandler

Overrides

ScreenTipShowing

Occurs when the screen tip is about to be shown. Cancellable.

Declaration
public event HeatMapScreenTipEventHandler ScreenTipShowing
Event Type
HeatMapScreenTipEventHandler

SelectedCellIndexChanged

Occurs when the selected cell index has changed.

Declaration
public event HeatMapIndexChangedEventHandler SelectedCellIndexChanged
Event Type
HeatMapIndexChangedEventHandler

SelectedCellIndexChanging

Occurs when the selected cell index is about to be changed. Cancellable.

Declaration
public event HeatMapIndexChangingEventHandler SelectedCellIndexChanging
Event Type
HeatMapIndexChangingEventHandler

ToolTipShowing

Occurs when the tool tip is about to be shown. Cancellable.

Declaration
public event HeatMapToolTipEventHandler ToolTipShowing
Event Type
HeatMapToolTipEventHandler

ToolTipTextNeeded

Declaration
public override event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Overrides

Extension Methods