Class

RadHeatMapElement

Initializes a new instance of the RadHeatMapElement class.

Declaration

public RadHeatMapElement()

Identifies the ColumnHeaderHeight dependency property for controlling column header cell height.

Declaration

public static RadProperty ColumnHeaderHeightProperty

Field Value

Identifies the HeaderCellBackColor dependency property for controlling header cell background color.

Declaration

public static RadProperty HeaderCellBackColorProperty

Field Value

Identifies the HeaderCellBorderColor dependency property for controlling header cell border color.

Declaration

public static RadProperty HeaderCellBorderColorProperty

Field Value

Identifies the HeaderCellBorderWidth dependency property for controlling header cell border width.

Declaration

public static RadProperty HeaderCellBorderWidthProperty

Field Value

Identifies the HeaderCellFont dependency property for styling header cell text.

Declaration

public static RadProperty HeaderCellFontProperty

Field Value

Identifies the HeaderCellForeColor dependency property for controlling header cell text color.

Declaration

public static RadProperty HeaderCellForeColorProperty

Field Value

Identifies the HeaderCellHoverBackColor dependency property for controlling header cell background color during mouse hover.

Declaration

public static RadProperty HeaderCellHoverBackColorProperty

Field Value

Identifies the HeaderCellHoverForeColor dependency property for controlling header cell text color during mouse hover.

Declaration

public static RadProperty HeaderCellHoverForeColorProperty

Field Value

Identifies the HoveredCellBorderColor dependency property for controlling data cell border color during mouse hover.

Declaration

public static RadProperty HoveredCellBorderColorProperty

Field Value

Identifies the HoveredCellBorderWidth dependency property for controlling data cell border width during mouse hover.

Declaration

public static RadProperty HoveredCellBorderWidthProperty

Field Value

Identifies the RowHeaderWidth dependency property for controlling row header cell width.

Declaration

public static RadProperty RowHeaderWidthProperty

Field Value

Identifies the SelectedCellBorderColor dependency property for controlling selected data cell border color.

Declaration

public static RadProperty SelectedCellBorderColorProperty

Field Value

Identifies the SelectedCellBorderWidth dependency property for controlling selected data cell border width.

Declaration

public static RadProperty SelectedCellBorderWidthProperty

Field Value

Declaration

public IDictionary<CellIndex, RectangleF> cellIndicesToRects

Field Value

Gets or sets a value indicating whether hot tracking behavior is enabled, allowing cells to be highlighted when hovered.

Declaration

public bool AllowHotTracking { get; set; }

Property Value

Gets or sets a value indicating whether cell selection functionality is enabled in the heat map.

Declaration

public bool AllowSelection { get; set; }

Property Value

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

Declaration

public bool AutoGenerateLegendItems { get; set; }

Property Value

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

Declaration

public ContentAlignment CellTextAlignment { get; set; }

Property Value

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

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

Declaration

public int ColumnHeaderHeight { get; set; }

Property Value

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

Declaration

public string ColumnHeaderTextFormat { get; set; }

Property Value

Gets or sets the position of column headers within the heat map layout.

Declaration

public ColumnHeadersPosition ColumnHeadersPosition { get; set; }

Property Value

Gets or sets the heat map definition that is responsible for managing the data source and organizing data into rows and columns for visualization.

Declaration

public HeatMapDefinition Definition { get; set; }

Property Value

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

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

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

Gets or sets the font used for rendering text within data cells of the heat map. This property defines the font face, size, and style attributes for cell text and is inheritable through the element tree.

Declaration

public override Font Font { get; set; }

Property Value

Overrides VisualElement.Font

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

Declaration

public Color HeaderCellBackColor { get; set; }

Property Value

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

Declaration

public Color HeaderCellBorderColor { get; set; }

Property Value

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

Declaration

public int HeaderCellBorderWidth { get; set; }

Property Value

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

Declaration

public Font HeaderCellFont { get; set; }

Property Value

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

Declaration

public Color HeaderCellForeColor { get; set; }

Property Value

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

Declaration

public Color HeaderCellHoverBackColor { get; set; }

Property Value

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

Declaration

public Color HeaderCellHoverForeColor { get; set; }

Property Value

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

Declaration

public ContentAlignment HeaderCellTextAlignment { get; set; }

Property Value

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

Declaration

public Color HoveredCellBorderColor { get; set; }

Property Value

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

Gets the index of the cell currently being hovered by the mouse cursor.

Declaration

[Browsable(false)]
public CellIndex HoveredCellIndex { get; protected set; }

Property Value

Gets a collection of HeatMapDataItem objects that represent the data items displayed in the heat map visualization.

Declaration

[Browsable(false)]
public HeatMapDataItemCollection Items { get; }

Property Value

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

Declaration

public LegendAlignment LegendAlignment { get; set; }

Property Value

Gets the HeatMapLegendElement that displays the heat map legend.

Declaration

public HeatMapLegendElement LegendElement { get; }

Property Value

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

Declaration

public Orientation LegendOrientation { get; set; }

Property Value

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

Declaration

public RadPosition LegendPosition { get; set; }

Property Value

Gets the StackLayoutElement that contains the legend element in the heat map layout.

Declaration

public StackLayoutElement LegendStack { get; }

Property Value

Gets or sets the text displayed as the title of the legend element.

Declaration

public string LegendTitle { get; set; }

Property Value

Gets or sets the format string used for displaying values in legend items.

Declaration

public string LegendValueFormat { get; set; }

Property Value

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

Declaration

public string RowHeaderTextFormat { get; set; }

Property Value

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

Declaration

public int RowHeaderWidth { get; set; }

Property Value

Gets or sets the position of row headers within the heat map layout.

Declaration

public RowHeadersPosition RowHeadersPosition { get; set; }

Property Value

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

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

Declaration

public Color SelectedCellBorderColor { get; set; }

Property Value

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

Declaration

public int SelectedCellBorderWidth { get; set; }

Property Value

Gets or sets the index of the currently selected cell in the heat map.

Declaration

[Browsable(false)]
public CellIndex SelectedCellIndex { get; set; }

Property Value

Gets the data item associated with the currently selected cell in the heat map.

Declaration

[Browsable(false)]
public HeatMapDataItem SelectedDataItem { get; }

Property Value

Gets or sets a value indicating whether the legend element should be displayed in the heat map visualization.

Declaration

public bool ShowLegend { get; set; }

Property Value

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

Declaration

public string Title { get; set; }

Property Value

Gets the HeatMapTitleElement that displays the heat map title.

Declaration

public HeatMapTitleElement TitleElement { get; }

Property Value

Gets the StackLayoutElement that contains the title element in the heat map layout.

Declaration

public StackLayoutElement TitleStack { get; }

Property Value

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

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

Declaration

public ToolTipDisplayMode ToolTipDisplayMode { get; set; }

Property Value

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

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

Adds a style property setting and clears the internal cache to ensure proper rendering updates.

Declaration

protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)

Parameters

Returns

Overrides RadElement.AddStylePropertySetting(IPropertySetting)

Arranges the heat map element and its child elements within the specified final size.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Creates and initializes the child elements including title stack, title element, legend stack, and legend element.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a new HeatMapLegendElement instance for displaying the heat map legend.

Declaration

protected virtual HeatMapLegendElement CreateLegendElement()

Returns

Creates a new StackLayoutElement instance to contain the heat map legend element.

Declaration

protected virtual StackLayoutElement CreateLegendStack()

Returns

Creates a new RadOffice2007ScreenTipElement instance for displaying screen tips when hovering over heat map cells.

Declaration

protected virtual RadOffice2007ScreenTipElement CreateScreenTipElement()

Returns

Creates a new HeatMapTitleElement instance for displaying the heat map title.

Declaration

protected virtual HeatMapTitleElement CreateTitleElement()

Returns

Creates a new StackLayoutElement instance to contain the heat map title element.

Declaration

protected virtual StackLayoutElement CreateTitleStack()

Returns

Creates a new RadToolTip instance for displaying tool tips when hovering over heat map cells.

Declaration

protected virtual RadToolTip CreateToolTip()

Returns

Releases the managed resources used by the RadHeatMapElement and optionally releases the unmanaged resources.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Determines the cell index at the specified location within the heat map content area.

Declaration

protected virtual void GetCellIndex(Point location, out int rowIndex, out int columnIndex)

Parameters

Calculates and returns the content rectangle available for painting the heat map, excluding borders, padding, title, and legend areas.

Declaration

protected virtual Rectangle GetContentPaintRectangle()

Returns

Declaration

public virtual string GetFormattedString(object header, string format)

Parameters

Returns

Declaration

protected virtual string GetFormattedText(double value)

Parameters

Returns

Initializes the default field values for the heat map element properties and appearance settings.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Manages the display of tool tips and screen tips based on the current mouse location and cell index.

Declaration

protected virtual void ManageToolTip(Point location, int rowIndex, int columnIndex)

Parameters

Measures the heat map element and its child elements based on the available size.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Handles bounds changes by updating cached cell bounds and invalidating the display.

Declaration

protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides UIItemBase.OnBoundsChanged(RadPropertyChangedEventArgs)

Raises the CellPainted event.

Declaration

protected virtual void OnCellPainted(HeatMapCellPaintedEventArgs args)

Parameters

Raises the HeaderCellPainted event.

Declaration

protected virtual void OnHeaderPainted(HeatMapHeaderCellPaintedEventArgs args)

Parameters

Raises the HeaderCellPainting event.

Declaration

protected virtual void OnHeaderPainting(HeatMapHeaderCellPaintingEventArgs args)

Parameters

Raises the HoveredCellIndexChanged event.

Declaration

protected virtual void OnHoveredCellIndexChanged(HeatMapIndexChangedEventArgs args)

Parameters

Raises the CellPainting event.

Declaration

protected virtual void OnItemPainting(HeatMapCellPaintingEventArgs args)

Parameters

Handles the element loaded event by updating the legend visibility and configuration.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Handles the mouse down event by updating the selected cell index when selection is enabled.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Handles the mouse leave event by hiding screen tips and resetting hover states.

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Overrides RadItem.OnMouseLeave(EventArgs)

Handles the mouse move event by updating hover tracking and managing tool tip display.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides LightVisualElement.OnMouseMove(MouseEventArgs)

Handles property changes by updating the internal cache and triggering necessary updates for display properties.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the ScreenTipShowing event.

Declaration

protected virtual void OnScreenTipShowing(HeatMapScreenTipEventArgs args)

Parameters

Raises the SelectedCellIndexChanged event.

Declaration

protected virtual void OnSelectedCellIndexChanged(HeatMapIndexChangedEventArgs args)

Parameters

Raises the SelectedCellIndexChanging event.

Declaration

protected virtual void OnSelectedCellIndexChanging(HeatMapIndexChangingEventArgs args)

Parameters

Prevents the default screen tip behavior from being executed.

Declaration

protected override bool OnShowScreenTip(ComponentInputBehavior inputBehavior)

Parameters

Returns

Overrides RadElement.OnShowScreenTip(ComponentInputBehavior)

Raises the ToolTipShowing event.

Declaration

protected virtual void OnToolTipShowing(HeatMapToolTipEventArgs args)

Parameters

Renders a single data cell with background color, border, and text based on the data item and current state.

Declaration

public virtual void PaintCell(IGraphics graphics, RectangleF rect, CellIndex cellIndex, HeatMapDataItem dataItem)

Parameters

Declaration

protected virtual void PaintCellBackground(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, Color backColor)

Parameters

Declaration

protected virtual void PaintCellBorder(CellIndex cellIndex, IGraphics graphics, RectangleF rectangle, Color borderColor, int borderWidth)