RadTreeMap
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadTreeMap...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadTreeMap class.
public RadTreeMap()Properties
Gets or sets the algorithm used to calculate the layout and positioning of rectangles in the tree map.
[Browsable(false)]
public TreeMapAlgorithm Algorithm { get; set; }Gets or sets a value indicating whether items are highlighted when the mouse hovers over them.
public bool AllowHotTracking { get; set; }Gets or sets a value indicating whether users can select items in the tree map by clicking on them.
public bool AllowSelection { get; set; }Gets or sets the colorizer that determines the background and foreground colors for tree map items.
[Browsable(false)]
public BaseColorizer Colorizer { get; set; }Gets or sets the data source that provides the hierarchical data to be visualized in the tree map.
[Browsable(true)]
public object DataSource { get; set; }Gets the default size of the RadTreeMap when a new instance is initialized.
protected override Size DefaultSize { get; }Overrides:
Gets or sets the name of the property from the data source that provides the display text for each item.
[Browsable(true)]
[TypeConverter("System.Windows.Forms.Design.DataMemberFieldConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string DisplayMember { get; set; }Gets or sets a value indicating whether automatic grouping of data items is enabled based on the GroupDescriptors.
public bool EnableGrouping { get; set; }Gets or sets the background color used for group headers and containers.
public Color GroupBackColor { get; set; }Gets or sets the border color used for group headers and containers.
public Color GroupBorderColor { get; set; }Gets a collection of GroupDescriptor objects that define the rules for automatically grouping tree map items.
[Browsable(true)]
public GroupDescriptorCollection GroupDescriptors { get; }Gets a collection of TreeMapDataItemGroup objects that represent the grouped data items in the tree map.
[Browsable(true)]
public TreeMapDataItemGroupCollection Groups { get; }Gets or sets the alignment of text within group headers.
public ContentAlignment GroupTextAlignment { get; set; }Gets the TreeMapDataItemGroup that is currently under the mouse cursor.
[Browsable(false)]
public TreeMapDataItemGroup HoveredGroup { get; }Gets the TreeMapDataItem that is currently under the mouse cursor.
[Browsable(false)]
public TreeMapDataItem HoveredItem { get; }Gets or sets the background color applied to items when they are hovered over by the mouse.
public Color HoveredItemBackColor { get; set; }Gets or sets the border color applied to items when they are hovered over by the mouse.
public Color HoveredItemBorderColor { get; set; }Gets or sets the thickness of the border applied to items when they are hovered over by the mouse.
public int HoveredItemBorderWidth { get; set; }Gets a collection of TreeMapDataItem objects that represent the individual data items in the tree map.
[Browsable(true)]
public TreeMapDataItemCollection Items { get; }Gets or sets the alignment of text within individual tree map items.
public ContentAlignment ItemTextAlignment { get; set; }Gets or sets the orientation of legend items when the legend is displayed.
public Orientation LegendOrientation { get; set; }Gets or sets the position where the legend is displayed relative to the tree map.
public RadPosition LegendPosition { get; set; }Gets or sets the title text displayed above the legend.
public string LegendTitle { get; set; }Gets or sets the currently selected TreeMapDataItemGroup.
[Browsable(false)]
public TreeMapDataItemGroup SelectedGroup { get; set; }Gets or sets the currently selected TreeMapDataItem.
[Browsable(false)]
public TreeMapDataItem SelectedItem { get; set; }Gets or sets the background color applied to items when they are selected.
public Color SelectedItemBackColor { get; set; }Gets or sets the border color applied to items when they are selected.
public Color SelectedItemBorderColor { get; set; }Gets or sets the thickness of the border applied to items when they are selected.
public int SelectedItemBorderWidth { get; set; }Gets or sets a value indicating whether a legend is displayed to explain the color coding of tree map items.
public bool ShowLegend { get; set; }Gets or sets the title text displayed at the top of the tree map control.
public string Title { get; set; }Gets or sets the mode for displaying tooltips when users hover over tree map items.
public ToolTipDisplayMode ToolTipDisplayMode { get; set; }Gets the core tree map element that handles the visualization and data processing.
[Browsable(false)]
public RadTreeMapElement TreeMapElement { get; }Gets or sets the name of the property from the data source that provides the quantitative value for each item.
[Browsable(true)]
public string ValueMember { get; set; }Gets or sets a value indicating whether text within tree map items should wrap to multiple lines when it exceeds the item's width.
public bool WrapItemText { get; set; }Methods
Applies the configured colorizer to all tree map items to set their background and foreground colors.
public virtual void ColorizeItems()Creates the child items for the parent element.
protected override void CreateChildItems(RadElement parent)The parent element that will contain the child items.
Overrides:
Creates the core tree map element that provides the visualization functionality.
protected virtual RadTreeMapElement CreateTreeMapElement()A new instance of RadTreeMapElement.
Recalculates the layout algorithm to determine the size and position of all tree map items based on their values.
public void EvaluateAlgorithm()Events
Occurs after the layout algorithm has been evaluated and all tree map items have been assigned their final bounds.
public event EventHandler AlgorithmEvaluatedOccurs after a tree map group and all its child items have been painted.
public event TreeMapGroupPaintedEventHandler GroupPaintedOccurs before a tree map group is painted, allowing customization of its appearance.
public event TreeMapGroupPaitingEventHandler GroupPaintingOccurs when the HoveredGroup property changes due to mouse movement.
public event TreeMapGroupChangedEventHandler HoveredGroupChangedOccurs when the HoveredItem property changes due to mouse movement.
public event TreeMapItemChangedEventHandler HoveredItemChangedOccurs when a TreeMapDataItem needs to be created during data binding operations.
public event TreeMapItemCreatingEventHandler ItemCreatingOccurs after a data-bound item has been attached to a TreeMapDataItem during data binding.
public event TreeMapItemEventHandler ItemDataBoundOccurs after a tree map item has been painted.
public event TreeMapItemPaitedEventHandler ItemPaintedOccurs before a tree map item is painted, allowing customization of its appearance.
public event TreeMapItemPaitingEventHandler ItemPaintingOccurs before a screen tip is displayed, allowing customization of the tip's content and appearance.
public event TreeMapScreenTipEventHandler ScreenTipShowingOccurs after the SelectedGroup property has changed.
public event TreeMapGroupChangedEventHandler SelectedGroupChangedOccurs before the SelectedGroup property changes, allowing the operation to be cancelled.
public event TreeMapGroupChangingEventHandler SelectedGroupChangingOccurs after the SelectedItem property has changed.
public event TreeMapItemChangedEventHandler SelectedItemChangedOccurs before the SelectedItem property changes, allowing the operation to be cancelled.
public event TreeMapItemChangingEventHandler SelectedItemChangingOccurs before a tooltip is displayed, allowing customization of the tooltip's content and appearance.
public event TreeMapToolTipEventHandler ToolTipShowing