Class TreeMapHighlightSettings

Sets and gets the options for customizing the highlight of the treemap item on mouse over of the treemap component item.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
TreeMapHighlightSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.TreeMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeMapHighlightSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

TreeMapHighlightSettings()

Declaration
public TreeMapHighlightSettings()

Properties

ChildContent

Gets or sets the content of the UI element.

Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment representing the child content for the UI element.
Remarks

This property allows you to define custom templates within the TreeMapHighlightSettings component.

Enable

Gets or sets a value indicating whether the highlight functionality of the treemap component is enabled.

Declaration
[Parameter]
public bool Enable { get; set; }
Property Value
Type Description
bool

A boolean value that enables (true) or disables (false) the highlight functionality. The default value is false.
Remarks

This property is used to control whether highlighting is active on the TreeMap component.

Fill

Gets or sets the highlight color of the treemap component.

Declaration
[Parameter]
public string Fill { get; set; }
Property Value
Type Description
string

A string representing the color used for highlighting. The default value is "#808080".
Remarks

Use this property to specify a custom color for the highlighted item in the TreeMap component.

Mode

Gets or sets the element in which highlight must be done in the treemap component.

Declaration
[Parameter]
public HighLightMode Mode { get; set; }
Property Value
Type Description
HighLightMode

A HighLightMode value that determines the scope of the highlight (e.g., item, group).
Remarks

This property specifies the target element level (item or group) for highlighting within the TreeMap.

Opacity

Gets or sets the opacity of the treemap component.

Declaration
[Parameter]
public double Opacity { get; set; }
Property Value
Type Description
double

A double value representing the opacity level. The default value is 0.5.
Remarks

This property allows adjusting the transparency of the highlighted area in the TreeMap component.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

Implements