ClassRadTreeMap
A data visualization control that displays hierarchical data as a set of nested rectangles, where each rectangle's size represents a quantitative value.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
public class RadTreeMap : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadTreeMap
Implements:
Inherited Members
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
[Browsable(false)]
public TreeMapAlgorithm Algorithm { get; set; }
Property Value
AllowHotTracking
Gets or sets a value indicating whether items are highlighted when the mouse hovers over them.
AllowSelection
Gets or sets a value indicating whether users can select items in the tree map by clicking on them.
Colorizer
Gets or sets the colorizer that determines the background and foreground colors for tree map items.
Declaration
[Browsable(false)]
public BaseColorizer Colorizer { get; set; }
Property Value
DataSource
Gets or sets the data source that provides the hierarchical data to be visualized in the tree map.
Declaration
[Browsable(true)]
public object DataSource { get; set; }
Property Value
DefaultSize
Gets the default size of the RadTreeMap when a new instance is initialized.
Declaration
protected override Size DefaultSize { get; }
Property Value
Overrides
DisplayMember
Gets or sets the name of the property from the data source that provides the display text for each item.
Declaration
[Browsable(true)]
[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string DisplayMember { get; set; }
Property Value
EnableGrouping
Gets or sets a value indicating whether automatic grouping of data items is enabled based on the GroupDescriptors.
GroupBackColor
Gets or sets the background color used for group headers and containers.
GroupBorderColor
Gets or sets the border color used for group headers and containers.
GroupDescriptors
Gets a collection of GroupDescriptor objects that define the rules for automatically grouping tree map items.
Declaration
[Browsable(true)]
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupTextAlignment
Gets or sets the alignment of text within group headers.
Declaration
public ContentAlignment GroupTextAlignment { get; set; }
Property Value
Groups
Gets a collection of TreeMapDataItemGroup objects that represent the grouped data items in the tree map.
Declaration
[Browsable(true)]
public TreeMapDataItemGroupCollection Groups { get; }
Property Value
HoveredGroup
Gets the TreeMapDataItemGroup that is currently under the mouse cursor.
Declaration
[Browsable(false)]
public TreeMapDataItemGroup HoveredGroup { get; }
Property Value
HoveredItem
Gets the TreeMapDataItem that is currently under the mouse cursor.
Declaration
[Browsable(false)]
public TreeMapDataItem HoveredItem { get; }
Property Value
HoveredItemBackColor
Gets or sets the background color applied to items when they are hovered over by the mouse.
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
HoveredItemBorderWidth
Gets or sets the thickness of the border applied to items when they are hovered over by the mouse.
ItemTextAlignment
Gets or sets the alignment of text within individual tree map items.
Declaration
public ContentAlignment ItemTextAlignment { get; set; }
Property Value
Items
Gets a collection of TreeMapDataItem objects that represent the individual data items in the tree map.
Declaration
[Browsable(true)]
public TreeMapDataItemCollection Items { get; }
Property Value
LegendOrientation
Gets or sets the orientation of legend items when the legend is displayed.
Declaration
public Orientation LegendOrientation { get; set; }
Property Value
LegendPosition
Gets or sets the position where the legend is displayed relative to the tree map.
Declaration
public RadPosition LegendPosition { get; set; }
Property Value
LegendTitle
Gets or sets the title text displayed above the legend.
SelectedGroup
Gets or sets the currently selected TreeMapDataItemGroup.
Declaration
[Browsable(false)]
public TreeMapDataItemGroup SelectedGroup { get; set; }
Property Value
SelectedItem
Gets or sets the currently selected TreeMapDataItem.
Declaration
[Browsable(false)]
public TreeMapDataItem SelectedItem { get; set; }
Property Value
SelectedItemBackColor
Gets or sets the background color applied to items when they are selected.
SelectedItemBorderColor
Gets or sets the border color applied to items when they are selected.
Declaration
public Color SelectedItemBorderColor { get; set; }
Property Value
SelectedItemBorderWidth
Gets or sets the thickness of the border applied to items when they are selected.
ShowLegend
Gets or sets a value indicating whether a legend is displayed to explain the color coding of tree map items.
Title
Gets or sets the title text displayed at the top of the tree map control.
ToolTipDisplayMode
Gets or sets the mode for displaying tooltips when users hover over tree map items.
Declaration
public ToolTipDisplayMode ToolTipDisplayMode { get; set; }
Property Value
TreeMapElement
Gets the core tree map element that handles the visualization and data processing.
Declaration
[Browsable(false)]
public RadTreeMapElement TreeMapElement { get; }
Property Value
ValueMember
Gets or sets the name of the property from the data source that provides the quantitative value for each item.
Declaration
[Browsable(true)]
public string ValueMember { get; set; }
Property Value
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.
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
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
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.
GroupPainted
Occurs after a tree map group and all its child items have been painted.
Declaration
public event TreeMapGroupPaintedEventHandler GroupPainted
Event Value
GroupPainting
Occurs before a tree map group is painted, allowing customization of its appearance.
Declaration
public event TreeMapGroupPaitingEventHandler GroupPainting
Event Value
HoveredGroupChanged
Occurs when the HoveredGroup property changes due to mouse movement.
Declaration
public event TreeMapGroupChangedEventHandler HoveredGroupChanged
Event Value
HoveredItemChanged
Occurs when the HoveredItem property changes due to mouse movement.
Declaration
public event TreeMapItemChangedEventHandler HoveredItemChanged
Event Value
ItemCreating
Occurs when a TreeMapDataItem needs to be created during data binding operations.
Declaration
public event TreeMapItemCreatingEventHandler ItemCreating
Event Value
ItemDataBound
Occurs after a data-bound item has been attached to a TreeMapDataItem during data binding.
Declaration
public event TreeMapItemEventHandler ItemDataBound
Event Value
ItemPainted
Occurs after a tree map item has been painted.
Declaration
public event TreeMapItemPaitedEventHandler ItemPainted
Event Value
ItemPainting
Occurs before a tree map item is painted, allowing customization of its appearance.
Declaration
public event TreeMapItemPaitingEventHandler ItemPainting
Event Value
ScreenTipShowing
Occurs before a screen tip is displayed, allowing customization of the tip's content and appearance.
Declaration
public event TreeMapScreenTipEventHandler ScreenTipShowing
Event Value
SelectedGroupChanged
Occurs after the SelectedGroup property has changed.
Declaration
public event TreeMapGroupChangedEventHandler SelectedGroupChanged
Event Value
SelectedGroupChanging
Occurs before the SelectedGroup property changes, allowing the operation to be cancelled.
Declaration
public event TreeMapGroupChangingEventHandler SelectedGroupChanging
Event Value
SelectedItemChanged
Occurs after the SelectedItem property has changed.
Declaration
public event TreeMapItemChangedEventHandler SelectedItemChanged
Event Value
SelectedItemChanging
Occurs before the SelectedItem property changes, allowing the operation to be cancelled.
Declaration
public event TreeMapItemChangingEventHandler SelectedItemChanging
Event Value
ToolTipShowing
Occurs before a tooltip is displayed, allowing customization of the tooltip's content and appearance.
Declaration
public event TreeMapToolTipEventHandler ToolTipShowing
Event Value