Class TreeMapLevel

Sets and gets the options for customizing the levels of the treemap component.

Inheritance

System.Object

TreeMapLevel

Namespace: Syncfusion.Blazor.TreeMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeMapLevel : OwningComponentBase

Constructors

TreeMapLevel()

Declaration

public TreeMapLevel()

Properties

AutoFill

Enables or disables the automatic filling of the colors in the items in the treemap component.

Declaration

public bool AutoFill { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether automatic color filling is enabled.

Remarks

When set to true, colors are automatically filled in the treemap items.

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment that represents the content of the UI element.

Remarks

This property is used to define a custom UI content for the treemap level.

Fill

Sets and gets the fill color of the level in the treemap component.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	A string representing the fill color of the level.

Remarks

This property allows customization of the fill color for a specific level in the treemap.

GroupGap

Sets and gets the gap between the levels in the treemap component.

Declaration

public double GroupGap { get; set; }

Property Value

Type	Description
System.Double	A double value indicating the gap between levels.

Remarks

Adjusting this property alters the spacing between the levels in the treemap.

GroupPadding

Sets and gets the padding of levels in the treemap component.

Declaration

public double GroupPadding { get; set; }

Property Value

Type	Description
System.Double	A double representing the padding for levels. The default value is 10.0.

Remarks

Use this property to define how much padding is applied around each level in the treemap.

GroupPath

Sets and gets the value path from the data source in the treemap component to render the item.

Declaration

public string GroupPath { get; set; }

Property Value

Type	Description
System.String	A string representing the path to the data source value.

Remarks

This property is used to define which data source property is used for rendering items in the treemap.

HeaderAlignment

Sets and gets the alignment of the header of the treemap component.

Declaration

public Alignment HeaderAlignment { get; set; }

Property Value

Type	Description
Alignment	An Alignment enumeration that defines the header alignment. The default value is Near.

Remarks

This property defines how the header text is aligned within the treemap level.

HeaderFormat

Sets and gets the format of header of the levels in the treemap component.

Declaration

public string HeaderFormat { get; set; }

Property Value

Type	Description
System.String	A string that defines the format of the header text.

Remarks

Customize the display format of the header text using this property.

HeaderHeight

Sets and gets the height of header in the treemap component.

Declaration

public double HeaderHeight { get; set; }

Property Value

Type	Description
System.Double	A double representing the height of the header. The default value is 20.0.

Remarks

Use this property to change the height of the header section of the treemap level.

HeaderTemplate

Sets and gets the template for header in the treemap component.

Declaration

public RenderFragment<object> HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment used as the template for the header.

Remarks

This property allows for custom template definition for headers within levels of the treemap.

Opacity

Sets and gets the opacity in the treemap component.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	A double defining the opacity level. The default value is 1.0.

Remarks

Control the transparency of the level using this opacity property.

ShowHeader

Shows or hides the header in level of the treemap component.

Declaration

public bool ShowHeader { get; set; }

Property Value

Type	Description
System.Boolean	A boolean that indicates whether the header is visible. The default value is true.

Remarks

This property can be used to toggle the visibility of the header for each level in the treemap.

TemplatePosition

Sets and gets the options for customizing the template position of the treemap component.

Declaration

public LabelPosition TemplatePosition { get; set; }

Property Value

Type	Description
LabelPosition	A LabelPosition enumeration that specifies the template position. The default value is TopLeft.

Remarks

This property allows adjustment of where the template is rendered in relation to the treemap item.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.