New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadTreeMap

Class

Represents the RadTreeMap control, a data visualization component for displaying hierarchical data as a set of nested rectangles.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[RequiredScript(typeof(Html5DataVizTreeMap))]
[ClientScriptResource("Telerik.Web.UI.RadTreeMap", "Telerik.Web.UI.TreeMap.RadTreeMapScripts.js")]
[ToolboxBitmap(typeof(RadTreeMap), "Toolbox.Icons.TreeMap.png")]
[TelerikToolboxCategory("Data")]
[EmbeddedSkin("TreeMap", typeof(RadTreeMap))]
[EmbeddedSkin("TreeMap", "Default", typeof(RadTreeMap))]
public class RadTreeMap : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadTreeMap...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members DataBoundControl.OnCreatingModelDataSource(CreatingModelDataSourceEventArgs)DataBoundControl.CreateDataSourceSelectArguments()DataBoundControl.GetData()DataBoundControl.MarkAsDataBound()DataBoundControl.OnDataPropertyChanged()DataBoundControl.OnDataSourceViewChanged(object, EventArgs)DataBoundControl.OnLoad(EventArgs)DataBoundControl.OnPagePreLoad(object, EventArgs)DataBoundControl.PerformSelect()DataBoundControl.ValidateDataSource(object)DataBoundControl.DataMemberDataBoundControl.IsUsingModelBindersDataBoundControl.ItemTypeDataBoundControl.SelectMethodDataBoundControl.DataSourceIDDataBoundControl.DataSourceObjectDataBoundControl.SelectArgumentsDataBoundControl.CreatingModelDataSourceDataBoundControl.CallingDataMethodsBaseDataBoundControl.ConfirmInitState()BaseDataBoundControl.DataBind()BaseDataBoundControl.EnsureDataBound()BaseDataBoundControl.OnDataBound(EventArgs)BaseDataBoundControl.OnInit(EventArgs)BaseDataBoundControl.DataSourceBaseDataBoundControl.InitializedBaseDataBoundControl.IsBoundUsingDataSourceIDBaseDataBoundControl.IsDataBindingAutomaticBaseDataBoundControl.SupportsDisabledAttributeBaseDataBoundControl.RequiresDataBindingBaseDataBoundControl.DataBoundWebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadTreeMap()

public RadTreeMap()

Properties

AlgorithmType

TreeMapAlgorithmType

Gets or sets the algorithm type used to visualize the control.

public virtual TreeMapAlgorithmType AlgorithmType { get; set; }

ClientItemTemplate

string

Gets or set the client item template of the control

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual string ClientItemTemplate { get; set; }

Colors

List<Color>

The default colors for the RadTreeMap tiles.

[Browsable(false)]
public List<Color> Colors { get; }

When all colors are used, new colors are pulled from the start again.

CssClassFormatString

string

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DataColorField

string

Gets or sets the data field holding the Color property for the currently bound TreeMapItem.

public virtual string DataColorField { get; set; }

DataFieldID

string

Gets or sets the data field holding the unique identifier for a TreeMapItem.

public virtual string DataFieldID { get; set; }

DataFieldParentID

string

Gets or sets the data field holding the ID of the parent TreeMapItem.

public virtual string DataFieldParentID { get; set; }

DataKeyNames

string[]

Gets or sets an array of data-field names that will be used to populate the TreeMapItem 's DataItem property which is used to populated the control's template.

[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
public virtual string[] DataKeyNames { get; set; }

Property Value:

An array that contains the names of the fields contained in the TreeMapItem's DataItem property.

Note: The dataItem's properties declared in the template should be with lower case .

DataTextField

string

Gets or sets the data field holding the Text property for the currently bound TreeMapItem.

public virtual string DataTextField { get; set; }

DataValueField

string

Gets or sets the data field holding the Value property for the currently bound TreeMapItem.

public virtual string DataValueField { get; set; }

Items

TreeMapItemCollection

Gets the Items collection of the control

[PersistenceMode(PersistenceMode.InnerProperty)]
public TreeMapItemCollection Items { get; }

OnClientItemCreated

string

Gets or sets the name of the client-side function which will be executed after an item is created

[Browsable(true)]
[Bindable(true)]
public string OnClientItemCreated { get; set; }

Property Value:

The default value is string.Empty.

OnClientLoad

string

Gets or sets the name of the client-side function which will be executed after the control is loaded

[Browsable(true)]
[Bindable(true)]
public string OnClientLoad { get; set; }

Property Value:

The default value is string.Empty.

ResolvedRenderMode

RenderMode

Gets the resolved render mode.

public override RenderMode ResolvedRenderMode { get; }

Property Value:

The resolved render mode.

Overrides: RadDataBoundControl.ResolvedRenderMode

SupportsRenderingMode

bool

protected override bool SupportsRenderingMode { get; }

Overrides: RadDataBoundControl.SupportsRenderingMode

TagKey

HtmlTextWriterTag

protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Methods

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeComponent(IScriptDescriptor)

GetDataSource()

protected override IDataSource GetDataSource()

Returns:

IDataSource

Overrides: DataBoundControl.GetDataSource()

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: DataBoundControl.LoadViewState(object)

OnPreRender(EventArgs)

protected override void OnPreRender(EventArgs e)

Parameters:eEventArgs

Overrides: RadDataBoundControl.OnPreRender(EventArgs)

PerformDataBinding(IEnumerable)

protected override void PerformDataBinding(IEnumerable data)

Parameters:dataIEnumerable

Overrides: DataBoundControl.PerformDataBinding(IEnumerable)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: DataBoundControl.SaveViewState()

TrackViewState()

protected override void TrackViewState()

Overrides: DataBoundControl.TrackViewState()

Events

ItemDataBound

TreeMapItemDataBoundEventHnadler

Occurs when TreeMapItem is bound

public event TreeMapItemDataBoundEventHnadler ItemDataBound