Class RadTreeMap

A data visualization control that displays hierarchical data as a set of nested rectangles, where each rectangle's size represents a quantitative value.

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

Syntax

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

Constructors

RadTreeMap()

Initializes a new instance of the RadTreeMap class.

Declaration
public RadTreeMap()

Properties

Algorithm

Gets or sets the algorithm used to calculate the layout and positioning of rectangles in the tree map.

Declaration
public TreeMapAlgorithm Algorithm { get; set; }
Property Value
TreeMapAlgorithm

AllowHotTracking

Gets or sets a value indicating whether items are highlighted when the mouse hovers over them.

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

AllowSelection

Gets or sets a value indicating whether users can select items in the tree map by clicking on them.

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

Colorizer

Gets or sets the colorizer that determines the background and foreground colors for tree map items.

Declaration
public BaseColorizer Colorizer { get; set; }
Property Value
BaseColorizer

DataSource

Gets or sets the data source that provides the hierarchical data to be visualized in the tree map.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

DefaultSize

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

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

DisplayMember

Gets or sets the name of the property from the data source that provides the display text for each item.

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

EnableGrouping

Gets or sets a value indicating whether automatic grouping of data items is enabled based on the GroupDescriptors.

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

GroupBackColor

Gets or sets the background color used for group headers and containers.

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

GroupBorderColor

Gets or sets the border color used for group headers and containers.

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

GroupDescriptors

Gets a collection of GroupDescriptor objects that define the rules for automatically grouping tree map items.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

Groups

Gets a collection of TreeMapDataItemGroup objects that represent the grouped data items in the tree map.

Declaration
public TreeMapDataItemGroupCollection Groups { get; }
Property Value
TreeMapDataItemGroupCollection

GroupTextAlignment

Gets or sets the alignment of text within group headers.

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

HoveredGroup

Gets the TreeMapDataItemGroup that is currently under the mouse cursor.

Declaration
public TreeMapDataItemGroup HoveredGroup { get; }
Property Value
TreeMapDataItemGroup

HoveredItem

Gets the TreeMapDataItem that is currently under the mouse cursor.

Declaration
public TreeMapDataItem HoveredItem { get; }
Property Value
TreeMapDataItem

HoveredItemBackColor

Gets or sets the background color applied to items when they are hovered over by the mouse.

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

HoveredItemBorderColor

Gets or sets the border color applied to items when they are hovered over by the mouse.

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

HoveredItemBorderWidth

Gets or sets the thickness of the border applied to items when they are hovered over by the mouse.

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

Items

Gets a collection of TreeMapDataItem objects that represent the individual data items in the tree map.

Declaration
public TreeMapDataItemCollection Items { get; }
Property Value
TreeMapDataItemCollection

ItemTextAlignment

Gets or sets the alignment of text within individual tree map items.

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

LegendOrientation

Gets or sets the orientation of legend items when the legend is displayed.

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

LegendPosition

Gets or sets the position where the legend is displayed relative to the tree map.

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

LegendTitle

Gets or sets the title text displayed above the legend.

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

SelectedGroup

Gets or sets the currently selected TreeMapDataItemGroup.

Declaration
public TreeMapDataItemGroup SelectedGroup { get; set; }
Property Value
TreeMapDataItemGroup

SelectedItem

Gets or sets the currently selected TreeMapDataItem.

Declaration
public TreeMapDataItem SelectedItem { get; set; }
Property Value
TreeMapDataItem

SelectedItemBackColor

Gets or sets the background color applied to items when they are selected.

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

SelectedItemBorderColor

Gets or sets the border color applied to items when they are selected.

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

SelectedItemBorderWidth

Gets or sets the thickness of the border applied to items when they are selected.

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

ShowLegend

Gets or sets a value indicating whether a legend is displayed to explain the color coding of tree map items.

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 at the top of the tree map control.

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

ToolTipDisplayMode

Gets or sets the mode for displaying tooltips when users hover over tree map items.

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

TreeMapElement

Gets the core tree map element that handles the visualization and data processing.

Declaration
public RadTreeMapElement TreeMapElement { get; }
Property Value
RadTreeMapElement

ValueMember

Gets or sets the name of the property from the data source that provides the quantitative value for each item.

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

WrapItemText

Gets or sets a value indicating whether text within tree map items should wrap to multiple lines when it exceeds the item's width.

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

Methods

ColorizeItems()

Applies the configured colorizer to all tree map items to set their background and foreground colors.

Declaration
public virtual void ColorizeItems()

CreateChildItems(RadElement)

Creates the child items for the parent element.

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

The parent element that will contain the child items.
Overrides

CreateTreeMapElement()

Creates the core tree map element that provides the visualization functionality.

Declaration
protected virtual RadTreeMapElement CreateTreeMapElement()
Returns
RadTreeMapElement

A new instance of RadTreeMapElement.

EvaluateAlgorithm()

Recalculates the layout algorithm to determine the size and position of all tree map items based on their values.

Declaration
public void EvaluateAlgorithm()

Events

AlgorithmEvaluated

Occurs after the layout algorithm has been evaluated and all tree map items have been assigned their final bounds.

Declaration
public event EventHandler AlgorithmEvaluated
Event Type
System.EventHandler

GroupPainted

Occurs after a tree map group and all its child items have been painted.

Declaration
public event TreeMapGroupPaintedEventHandler GroupPainted
Event Type
TreeMapGroupPaintedEventHandler

GroupPainting

Occurs before a tree map group is painted, allowing customization of its appearance.

Declaration
public event TreeMapGroupPaitingEventHandler GroupPainting
Event Type
TreeMapGroupPaitingEventHandler

HoveredGroupChanged

Occurs when the HoveredGroup property changes due to mouse movement.

Declaration
public event TreeMapGroupChangedEventHandler HoveredGroupChanged
Event Type
TreeMapGroupChangedEventHandler

HoveredItemChanged

Occurs when the HoveredItem property changes due to mouse movement.

Declaration
public event TreeMapItemChangedEventHandler HoveredItemChanged
Event Type
TreeMapItemChangedEventHandler

ItemCreating

Occurs when a TreeMapDataItem needs to be created during data binding operations.

Declaration
public event TreeMapItemCreatingEventHandler ItemCreating
Event Type
TreeMapItemCreatingEventHandler

ItemDataBound

Occurs after a data-bound item has been attached to a TreeMapDataItem during data binding.

Declaration
public event TreeMapItemEventHandler ItemDataBound
Event Type
TreeMapItemEventHandler

ItemPainted

Occurs after a tree map item has been painted.

Declaration
public event TreeMapItemPaitedEventHandler ItemPainted
Event Type
TreeMapItemPaitedEventHandler

ItemPainting

Occurs before a tree map item is painted, allowing customization of its appearance.

Declaration
public event TreeMapItemPaitingEventHandler ItemPainting
Event Type
TreeMapItemPaitingEventHandler

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 of the tip's content and appearance.

Declaration
public event TreeMapScreenTipEventHandler ScreenTipShowing
Event Type
TreeMapScreenTipEventHandler

SelectedGroupChanged

Occurs after the SelectedGroup property has changed.

Declaration
public event TreeMapGroupChangedEventHandler SelectedGroupChanged
Event Type
TreeMapGroupChangedEventHandler

SelectedGroupChanging

Occurs before the SelectedGroup property changes, allowing the operation to be cancelled.

Declaration
public event TreeMapGroupChangingEventHandler SelectedGroupChanging
Event Type
TreeMapGroupChangingEventHandler

SelectedItemChanged

Occurs after the SelectedItem property has changed.

Declaration
public event TreeMapItemChangedEventHandler SelectedItemChanged
Event Type
TreeMapItemChangedEventHandler

SelectedItemChanging

Occurs before the SelectedItem property changes, allowing the operation to be cancelled.

Declaration
public event TreeMapItemChangingEventHandler SelectedItemChanging
Event Type
TreeMapItemChangingEventHandler

ToolTipShowing

Occurs before a tooltip is displayed, allowing customization of the tooltip's content and appearance.

Declaration
public event TreeMapToolTipEventHandler ToolTipShowing
Event Type
TreeMapToolTipEventHandler

ToolTipTextNeeded

This event is not relevant for this class.

Declaration
public override event ToolTipTextNeededEventHandler ToolTipTextNeeded
Event Type
ToolTipTextNeededEventHandler

Overrides

Extension Methods