Class TreeMapLeafItemSettings
Sets and gets the options for customizing the leaf item of the treemap component.
Inheritance
Namespace: Syncfusion.Blazor.TreeMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeMapLeafItemSettings : OwningComponentBase
Constructors
TreeMapLeafItemSettings()
Declaration
public TreeMapLeafItemSettings()
Properties
AutoFill
Enables or disables automatic filling of colors in leaf items of the treemap component.
Declaration
public bool AutoFill { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | A boolean indicating whether auto-fill is enabled. Defaults to |
Remarks
When enabled, the treemap automatically selects colors for leaf 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 representing the content of the UI element. Default value is |
Remarks
This property allows you to define the content to be rendered within this component.
Fill
Sets and gets the fill color of leaf items in the treemap component.
Declaration
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string specifying the fill color of leaf items. Default value is |
Remarks
Use this property to set a specific color for all leaf items in the treemap.
Gap
Sets and gets the gap between the leaf item in the treemap component.
Declaration
public double Gap { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A double specifying the gap size between leaf items. Defaults to |
Remarks
The gap setting can help distinguish individual items in a densely packed treemap.
InterSectAction
Sets and gets the label intersect action of leaf item in the treemap component.
Declaration
public LabelAlignment InterSectAction { get; set; }
Property Value
Type | Description |
---|---|
LabelAlignment | A LabelAlignment enumerating how labels intersect within the component. Default is Trim. |
Remarks
This property controls how labels handle intersections, such as whether they are trimmed or hidden.
LabelFormat
Sets and gets the label text format of leaf item in the treemap component.
Declaration
public string LabelFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string representing the format of the label text. Default value is |
Remarks
Use format strings compatible with .NET string formatting conventions.
LabelPath
Sets and gets the value path from the data source for label of leaf item in the treemap component.
Declaration
public string LabelPath { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string indicating the data source path for the leaf item's label. Default value is |
Remarks
This property is used to extract label values from the underlying data source.
LabelPosition
Sets and gets the position of the labels in the treemap component.
Declaration
public LabelPosition LabelPosition { get; set; }
Property Value
Type | Description |
---|---|
LabelPosition | A LabelPosition specifying where labels are positioned. Default is TopLeft. |
Remarks
Adjust the label positioning to align with the component's styling and layout needs.
LabelTemplate
Sets and gets the label template of leaf item in the treemap component.
Declaration
public RenderFragment<object> LabelTemplate { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.RenderFragment<System.Object> | A |
Remarks
Utilize this template to present custom labels or additional content on leaf items.
Opacity
Sets and gets the opacity of leaf item in the treemap component.
Declaration
public double Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A double representing the opacity. Default is |
Remarks
This property controls the transparency level of leaf items.
Padding
Sets and gets the padding of leaf item in the treemap component.
Declaration
public double Padding { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A double specifying padding size. Default is |
Remarks
Padding is used to add space around the content within each leaf item.
ShowLabels
Shows or hides the labels in the treemap component.
Declaration
public bool ShowLabels { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | A boolean indicating whether labels are visible. Defaults to |
Remarks
This property can be used to toggle label visibility for specific visualization needs.
TemplatePosition
Sets and gets the position of the template of leaf item in the treemap component.
Declaration
public LabelPosition TemplatePosition { get; set; }
Property Value
Type | Description |
---|---|
LabelPosition | A LabelPosition for template positioning. Default is Center. |
Remarks
Adjusts where the template content is rendered within each leaf 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. |