Show / Hide Table of Contents

Class IgbTreemap

Inheritance
System.Object
BaseRendererControl
IgbTreemap
Implements
JsonSerializable
System.IDisposable
Inherited Members
BaseRendererControl._cachedSerializedContent
BaseRendererControl.ResolveDisplay()
BaseRendererControl.ToSpinal(String)
BaseRendererControl.TransformSimpleKey(String)
BaseRendererControl.BuildSequenceInfo(Int32)
BaseRendererControl.BuildRenderTree(RenderTreeBuilder)
BaseRendererControl.TemplateContentType(String)
BaseRendererControl.OnAfterRenderAsync(Boolean)
BaseRendererControl.EnsureReady()
BaseRendererControl.MarkPropDirty(String)
BaseRendererControl.IsPropDirty(String)
BaseRendererControl.Serialize(SerializationContext, String)
BaseRendererControl.Serialize()
BaseRendererControl.InvokeMethod(String, Object[], String[])
BaseRendererControl.InvokeMethodSync(String, Object[], String[])
BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)
BaseRendererControl.OnRefChanged(String, Object)
BaseRendererControl.OnInvokeReturn(Int64, Object)
BaseRendererControl.Camelize(String)
BaseRendererControl.ToPascal(String)
BaseRendererControl.Dispose(Boolean)
BaseRendererControl.Finalize()
BaseRendererControl.Dispose()
BaseRendererControl.IgBlazor
BaseRendererControl.Height
BaseRendererControl.Width
BaseRendererControl.Class
BaseRendererControl.AdditionalAttributes
BaseRendererControl.ParentTypeName
BaseRendererControl.ChildContent
BaseRendererControl.SupportsVisualChildren
BaseRendererControl.UseDirectRender
BaseRendererControl.DirectRenderElementName
BaseRendererControl.NeedsDynamicContent
BaseRendererControl.UseCamelEnumValues
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTreemap : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbTreemap()

Declaration
public IgbTreemap()

Properties

ActualInteractionPixelScalingRatio

Gets or sets the resolved scaling value used to affect the pixel density of the control while it is animating.

Declaration
public double ActualInteractionPixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

ActualPixelScalingRatio

Declaration
public double ActualPixelScalingRatio { get; set; }
Property Value
Type Description
System.Double

BreadcrumbSequence

Gets or sets the root title to use for breadcrumbs.

Declaration
public string BreadcrumbSequence { get; set; }
Property Value
Type Description
System.String

CustomValueMemberPath

Gets or sets the path to use to get the custom value of the items.

Declaration
public string CustomValueMemberPath { get; set; }
Property Value
Type Description
System.String

DarkTextColor

Gets or sets the dark text color to use for the nodes.

Declaration
public string DarkTextColor { get; set; }
Property Value
Type Description
System.String

DataSource

Gets or sets the (possibly hierarchical) data to assign to the TreeMap.

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

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

Declaration
public string DataSourceScript { get; set; }
Property Value
Type Description
System.String

FillBrushes

Gets or sets brushes to use for the fill scale.

Declaration
public string FillBrushes { get; set; }
Property Value
Type Description
System.String

FillScaleLogarithmBase

Gets or sets the logarithm base to use if the fill scale is logarithmic.

Declaration
public int FillScaleLogarithmBase { get; set; }
Property Value
Type Description
System.Int32

FillScaleMaximumValue

Gets or sets the maximum value to use for the fill scale.

Declaration
public double FillScaleMaximumValue { get; set; }
Property Value
Type Description
System.Double

FillScaleMinimumValue

Gets or sets the minimum value to use for the fill scale.

Declaration
public double FillScaleMinimumValue { get; set; }
Property Value
Type Description
System.Double

FillScaleMode

Gets or sets mode to use for the fill scale.

Declaration
public TreemapFillScaleMode FillScaleMode { get; set; }
Property Value
Type Description
TreemapFillScaleMode

FocusItem

Gets or sets the item to drill to in the treemap.

Declaration
public object FocusItem { get; set; }
Property Value
Type Description
System.Object

FocusItemScript

Provides a means of setting FocusItem in the JavaScript environment.

Declaration
public string FocusItemScript { get; set; }
Property Value
Type Description
System.String

FontFamily

Declaration
public string FontFamily { get; set; }
Property Value
Type Description
System.String

FontSize

Declaration
public double FontSize { get; set; }
Property Value
Type Description
System.Double

FontStyle

Declaration
public string FontStyle { get; set; }
Property Value
Type Description
System.String

FontWeight

Declaration
public string FontWeight { get; set; }
Property Value
Type Description
System.String

HeaderBackground

Gets or sets the background to use for the header.

Declaration
public string HeaderBackground { get; set; }
Property Value
Type Description
System.String

HeaderDarkTextColor

Gets or sets the dark text color to use for the header.

Declaration
public string HeaderDarkTextColor { get; set; }
Property Value
Type Description
System.String

HeaderDisplayMode

Gets or sets the font to use for header nodes

Declaration
public TreemapHeaderDisplayMode HeaderDisplayMode { get; set; }
Property Value
Type Description
TreemapHeaderDisplayMode

HeaderFontFamily

Declaration
public string HeaderFontFamily { get; set; }
Property Value
Type Description
System.String

HeaderFontSize

Declaration
public double HeaderFontSize { get; set; }
Property Value
Type Description
System.Double

HeaderFontStyle

Declaration
public string HeaderFontStyle { get; set; }
Property Value
Type Description
System.String

HeaderFontWeight

Declaration
public string HeaderFontWeight { get; set; }
Property Value
Type Description
System.String

HeaderHeight

Gets or sets the height to use for the header.

Declaration
public double HeaderHeight { get; set; }
Property Value
Type Description
System.Double

HeaderHoverBackground

Gets or sets the background to use for the header when it is hovered.

Declaration
public string HeaderHoverBackground { get; set; }
Property Value
Type Description
System.String

HeaderHoverDarkTextColor

Gets or sets the dark text color to use for the header when hovered.

Declaration
public string HeaderHoverDarkTextColor { get; set; }
Property Value
Type Description
System.String

HeaderHoverTextColor

Gets or sets the text color to use for the header.

Declaration
public string HeaderHoverTextColor { get; set; }
Property Value
Type Description
System.String

HeaderLabelBottomMargin

Gets or sets the bottom margin to use for the header.

Declaration
public double HeaderLabelBottomMargin { get; set; }
Property Value
Type Description
System.Double

HeaderLabelLeftMargin

Gets or sets the left margin to use for the header.

Declaration
public double HeaderLabelLeftMargin { get; set; }
Property Value
Type Description
System.Double

HeaderLabelRightMargin

Gets or sets the right margin to use for the header.

Declaration
public double HeaderLabelRightMargin { get; set; }
Property Value
Type Description
System.Double

HeaderLabelTopMargin

Gets or sets the top margin to use for the header.

Declaration
public double HeaderLabelTopMargin { get; set; }
Property Value
Type Description
System.Double

HeaderTextColor

Gets or sets the text color to use for the header.

Declaration
public string HeaderTextColor { get; set; }
Property Value
Type Description
System.String

IdMemberPath

Gets or sets the path to use to get the id of the items.

Declaration
public string IdMemberPath { get; set; }
Property Value
Type Description
System.String

InteractionPixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control while it is animating.

Declaration
public double InteractionPixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

IsFillScaleLogarithmic

Gets or sets whether the fill scale is logarithmic.

Declaration
public bool IsFillScaleLogarithmic { get; set; }
Property Value
Type Description
System.Boolean

LabelBottomMargin

Gets or sets the bottom margin to use for the labels.

Declaration
public double LabelBottomMargin { get; set; }
Property Value
Type Description
System.Double

LabelHorizontalAlignment

Gets or sets the horizontal alignment to use for the node labels.

Declaration
public HorizontalAlignment LabelHorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment

LabelHorizontalFitMode

Gets or sets the horizontal fit mode to use for the node labels.

Declaration
public TreemapLabelHorizontalFitMode LabelHorizontalFitMode { get; set; }
Property Value
Type Description
TreemapLabelHorizontalFitMode

LabelLeftMargin

Gets or sets the left margin to use for the labels.

Declaration
public double LabelLeftMargin { get; set; }
Property Value
Type Description
System.Double

LabelMemberPath

Gets or sets the path to use to get the Label of the items.

Declaration
public string LabelMemberPath { get; set; }
Property Value
Type Description
System.String

LabelRightMargin

Gets or sets the right margin to use for the labels.

Declaration
public double LabelRightMargin { get; set; }
Property Value
Type Description
System.Double

LabelTopMargin

Gets or sets the top margin to use for the labels.

Declaration
public double LabelTopMargin { get; set; }
Property Value
Type Description
System.Double

LabelVerticalAlignment

Gets or sets the vertical alignment to use for the node labels.

Declaration
public VerticalAlignment LabelVerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignment

LabelVerticalFitMode

Gets or sets the vertical fit mode to use for the node labels.

Declaration
public TreemapLabelVerticalFitMode LabelVerticalFitMode { get; set; }
Property Value
Type Description
TreemapLabelVerticalFitMode

LayoutOrientation

Gets or sets the orientation to use for the stripped and slice and dice layout types.

Declaration
public TreemapOrientation LayoutOrientation { get; set; }
Property Value
Type Description
TreemapOrientation

LayoutType

Gets or sets the type of layout to use for the nodes.

Declaration
public TreemapLayoutType LayoutType { get; set; }
Property Value
Type Description
TreemapLayoutType

MinimumDisplaySize

Gets or sets the minimum size (width or height) to display a node.

Declaration
public double MinimumDisplaySize { get; set; }
Property Value
Type Description
System.Double

NodePointerEnter

Declaration
public Action<IgbTreemapNodePointerEventArgs> NodePointerEnter { get; set; }
Property Value
Type Description
System.Action<IgbTreemapNodePointerEventArgs>

NodePointerEnterScript

Declaration
public string NodePointerEnterScript { get; set; }
Property Value
Type Description
System.String

NodePointerLeave

Declaration
public Action<IgbTreemapNodePointerEventArgs> NodePointerLeave { get; set; }
Property Value
Type Description
System.Action<IgbTreemapNodePointerEventArgs>

NodePointerLeaveScript

Declaration
public string NodePointerLeaveScript { get; set; }
Property Value
Type Description
System.String

NodePointerOver

Declaration
public Action<IgbTreemapNodePointerEventArgs> NodePointerOver { get; set; }
Property Value
Type Description
System.Action<IgbTreemapNodePointerEventArgs>

NodePointerOverScript

Declaration
public string NodePointerOverScript { get; set; }
Property Value
Type Description
System.String

NodePointerPressed

Declaration
public EventCallback<IgbTreemapNodePointerEventArgs> NodePointerPressed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbTreemapNodePointerEventArgs>

NodePointerPressedScript

Declaration
public string NodePointerPressedScript { get; set; }
Property Value
Type Description
System.String

NodePointerReleased

Declaration
public EventCallback<IgbTreemapNodePointerEventArgs> NodePointerReleased { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbTreemapNodePointerEventArgs>

NodePointerReleasedScript

Declaration
public string NodePointerReleasedScript { get; set; }
Property Value
Type Description
System.String

NodeStyling

Declaration
public EventCallback<IgbTreemapNodeStylingEventArgs> NodeStyling { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbTreemapNodeStylingEventArgs>

NodeStylingScript

Declaration
public string NodeStylingScript { get; set; }
Property Value
Type Description
System.String

Outline

Gets or sets the outline to use for the nodes.

Declaration
public string Outline { get; set; }
Property Value
Type Description
System.String

OverlayHeaderBackground

Gets or sets the background to use for the overlay header.

Declaration
public string OverlayHeaderBackground { get; set; }
Property Value
Type Description
System.String

OverlayHeaderHoverBackground

Gets or sets the background to use for the overlay header when it is hovered.

Declaration
public string OverlayHeaderHoverBackground { get; set; }
Property Value
Type Description
System.String

OverlayHeaderLabelBottomMargin

Gets or sets the bottom margin to use for the overlay header.

Declaration
public double OverlayHeaderLabelBottomMargin { get; set; }
Property Value
Type Description
System.Double

OverlayHeaderLabelLeftMargin

Gets or sets the left margin to use for the overlay header.

Declaration
public double OverlayHeaderLabelLeftMargin { get; set; }
Property Value
Type Description
System.Double

OverlayHeaderLabelRightMargin

Gets or sets the right margin to use for the overlay header.

Declaration
public double OverlayHeaderLabelRightMargin { get; set; }
Property Value
Type Description
System.Double

OverlayHeaderLabelTopMargin

Gets or sets the top margin to use for the overlay header.

Declaration
public double OverlayHeaderLabelTopMargin { get; set; }
Property Value
Type Description
System.Double

ParentIdMemberPath

Gets or sets the path to use to get the Parent of the items.

Declaration
public string ParentIdMemberPath { get; set; }
Property Value
Type Description
System.String

ParentNodeBottomMargin

Gets or sets the bottom margin to use for the parent nodes.

Declaration
public double ParentNodeBottomMargin { get; set; }
Property Value
Type Description
System.Double

ParentNodeBottomPadding

Gets or sets the bottom padding to use for the parent nodes.

Declaration
public double ParentNodeBottomPadding { get; set; }
Property Value
Type Description
System.Double

ParentNodeLeftMargin

Gets or sets the left margin to use for the parent nodes.

Declaration
public double ParentNodeLeftMargin { get; set; }
Property Value
Type Description
System.Double

ParentNodeLeftPadding

Gets or sets the left padding to use for the parent nodes.

Declaration
public double ParentNodeLeftPadding { get; set; }
Property Value
Type Description
System.Double

ParentNodeRightMargin

Gets or sets the right margin to use for the parent nodes.

Declaration
public double ParentNodeRightMargin { get; set; }
Property Value
Type Description
System.Double

ParentNodeRightPadding

Gets or sets the right padding to use for the parent nodes.

Declaration
public double ParentNodeRightPadding { get; set; }
Property Value
Type Description
System.Double

ParentNodeTopMargin

Gets or sets the top margin to use for the parent nodes.

Declaration
public double ParentNodeTopMargin { get; set; }
Property Value
Type Description
System.Double

ParentNodeTopPadding

Gets or sets the top padding to use for the parent nodes.

Declaration
public double ParentNodeTopPadding { get; set; }
Property Value
Type Description
System.Double

PixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control.

Declaration
public double PixelScalingRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

RootTitle

Gets or sets the root title to use for breadcrumbs.

Declaration
public string RootTitle { get; set; }
Property Value
Type Description
System.String

StrokeThickness

Gets or sets the stroke thickness to use for the node outline.

Declaration
public double StrokeThickness { get; set; }
Property Value
Type Description
System.Double

StyleMappings

Represents a series of mappings to provide style to various nodes within the treemap.

Declaration
public IgbTreemapNodeStyleMappingCollection StyleMappings { get; protected set; }
Property Value
Type Description
IgbTreemapNodeStyleMappingCollection

TextColor

Gets or sets the text color to use for the nodes.

Declaration
public string TextColor { get; set; }
Property Value
Type Description
System.String

TransitionDuration

Gets or sets the number of milliseconds over which changes to the gauge should be animated.

Declaration
public int TransitionDuration { get; set; }
Property Value
Type Description
System.Int32

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides
BaseRendererControl.Type

ValueMemberPath

Gets or sets path to use to get the values from the items.

Declaration
public string ValueMemberPath { get; set; }
Property Value
Type Description
System.String

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
BaseRendererControl.EnsureModulesLoaded()

ExportSerializedVisualData()

Declaration
public string ExportSerializedVisualData()
Returns
Type Description
System.String

ExportSerializedVisualDataAsync()

Returns visuals as a serialized string.

Declaration
public Task<string> ExportSerializedVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides
BaseRendererControl.FindByName(String)

Flush()

Declaration
public void Flush()

FlushAsync()

Declaration
public Task FlushAsync()
Returns
Type Description
System.Threading.Tasks.Task

MarkDirty()

Declaration
public void MarkDirty()

MarkDirtyAsync()

Declaration
public Task MarkDirtyAsync()
Returns
Type Description
System.Threading.Tasks.Task

NotifyClearItems(Object)

Declaration
public void NotifyClearItems(object source_)
Parameters
Type Name Description
System.Object source_

NotifyClearItemsAsync(Object)

Manually notifies the treemap's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable.

Declaration
public Task NotifyClearItemsAsync(object source_)
Parameters
Type Name Description
System.Object source_

The data source.

Returns
Type Description
System.Threading.Tasks.Task

NotifyInsertItem(Object, Int32, Object)

Declaration
public void NotifyInsertItem(object source_, int index, object newItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object newItem

NotifyInsertItemAsync(Object, Int32, Object)

Declaration
public Task NotifyInsertItemAsync(object source_, int index, object newItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

NotifyRemoveItem(Object, Int32, Object)

Declaration
public void NotifyRemoveItem(object source_, int index, object oldItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object oldItem

NotifyRemoveItemAsync(Object, Int32, Object)

Declaration
public Task NotifyRemoveItemAsync(object source_, int index, object oldItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object oldItem
Returns
Type Description
System.Threading.Tasks.Task

NotifySetItem(Object, Int32, Object, Object)

Declaration
public void NotifySetItem(object source_, int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object oldItem
System.Object newItem

NotifySetItemAsync(Object, Int32, Object, Object)

Declaration
public Task NotifySetItemAsync(object source_, int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Object source_
System.Int32 index
System.Object oldItem
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

NotifySizeChanged()

Declaration
public void NotifySizeChanged()

NotifySizeChangedAsync()

Declaration
public Task NotifySizeChangedAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnAttachedToUI()

Declaration
public void OnAttachedToUI()

OnAttachedToUIAsync()

Declaration
public Task OnAttachedToUIAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnDetachedFromUI()

Declaration
public void OnDetachedFromUI()

OnDetachedFromUIAsync()

Declaration
public Task OnDetachedFromUIAsync()
Returns
Type Description
System.Threading.Tasks.Task

SimulateHover(Point)

Declaration
public void SimulateHover(Point point)
Parameters
Type Name Description
Point point

SimulateHoverAsync(Point)

Declaration
public Task SimulateHoverAsync(Point point)
Parameters
Type Name Description
Point point
Returns
Type Description
System.Threading.Tasks.Task

Implements

JsonSerializable
System.IDisposable