Class TreeMapSubtitleSettings

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

Inheritance

System.Object

TreeMapSubtitleSettings

Namespace: Syncfusion.Blazor.TreeMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeMapSubtitleSettings : OwningComponentBase

Constructors

TreeMapSubtitleSettings()

Declaration

public TreeMapSubtitleSettings()

Properties

Alignment

Sets and gets the alignment of the subtitle text in the Treemap component.

Declaration

public Alignment Alignment { get; set; }

Property Value

Type	Description
Alignment	An Alignment enumeration specifying the alignment of the subtitle text. The default is Center.

Remarks

The alignment determines the positioning of the subtitle text within the Treemap's subtitle area.

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 custom content of the Treemap subtitle.

Remarks

This allows for the definition of additional content or components to be rendered with the Treemap subtitle.

Description

Defines the description for the subtitle used for accessibility in the Treemap component.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A string providing the description of the subtitle, aiding accessibility tools in describing the subtitle.

Remarks

This property can be used to improve accessibility by providing meaningful context for screen readers.

Text

Sets and gets the text for the subtitle in the Treemap component.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string specifying the subtitle text to be displayed in the Treemap component.

Remarks

This property determines the text content displayed as the subtitle of the Treemap.

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.