Class TreeMapEvents

Specifies the events to be triggered in the treemap component.

Inheritance

System.Object

TreeMapEvents

Namespace: Syncfusion.Blazor.TreeMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeMapEvents : ComponentBase

Constructors

TreeMapEvents()

Declaration

public TreeMapEvents()

Properties

DrillCompleted

Triggers after drill down functionality gets completed in the treemap.

Declaration

public EventCallback<DrillEndEventArgs> DrillCompleted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DrillEndEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs once the drill down action is finished in the treemap.

Remarks

This event is useful for handling data presentation changes after a drill down action.

ItemHighlighted

Triggers after highlighting on the treemap item.

Declaration

public EventCallback<ItemHighlightEventArgs> ItemHighlighted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ItemHighlightEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> invoked when a treemap item is highlighted.

Remarks

Use this event to adjust the UI or data when an item receives focus or is highlighted.

ItemRendering

Triggers before item rendering in the treemap component.

Declaration

public EventCallback<ItemRenderingEventArgs> ItemRendering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ItemRenderingEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs before rendering an item.

Remarks

This event is beneficial for modifying item appearance or data before rendering.

ItemSelected

Triggers after selecting a treemap item.

Declaration

public EventCallback<ItemSelectedEventArgs> ItemSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ItemSelectedEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that is invoked when a treemap item is selected.

Remarks

Use this event to handle item selection, which may include updating UI elements or data.

LegendItemRendering

Triggers before rendering each legend item in the treemap.

Declaration

public EventCallback<LegendItemRenderingEventArgs> LegendItemRendering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LegendItemRenderingEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> invoked before an individual legend item is rendered.

Remarks

Useful for modifying the properties or look of each legend item before they appear on screen.

LegendRendering

Triggers before rendering the legend in the treemap.

Declaration

public EventCallback<LegendRenderingEventArgs> LegendRendering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LegendRenderingEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs before the legend rendering process.

Remarks

Use this event to customize legends appearance or data before they are drawn.

Load

Triggers when the treemap is on load.

Declaration

public EventCallback<LoadEventArgs> Load { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs when the treemap begins loading.

Remarks

This event is useful for initial setup and configuration before the treemap displays its data.

Loaded

Triggers after treemap is rendered.

Declaration

public EventCallback<LoadedEventArgs> Loaded { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadedEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs once the treemap rendering completes.

Remarks

Use this event to perform actions or modifications after the treemap is fully rendered.

OnClick

Triggers after clicking on the treemap.

Declaration

public EventCallback<ClickEventArgs> OnClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that is invoked when the treemap is clicked.

Remarks

Use this event to respond to click actions on the treemap, which can include navigation or selection changes.

OnDoubleClick

Triggers after double clicking on the treemap.

Declaration

public EventCallback<DoubleClickEventArgs> OnDoubleClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DoubleClickEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that is triggered upon a double-click action on the treemap.

Remarks

This event is typically used to perform actions that require a double-click, such as opening detailed views.

OnDrillStart

Triggers on performing drill down functionality in the treemap.

Declaration

public EventCallback<DrillStartEventArgs> OnDrillStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DrillStartEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> invoked when a drill down action is initiated.

Remarks

Use this event to manage state or prepare data for the drill down process.

OnItemClick

Triggers after clicking an item in the treemap.

Declaration

public EventCallback<ItemClickEventArgs> OnItemClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ItemClickEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs when an item in the treemap is clicked.

Remarks

Utilize this event to handle actions when a treemap item receives a click input.

OnItemMove

Triggers after mouse hover on the treemap item.

Declaration

public EventCallback<ItemMoveEventArgs> OnItemMove { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ItemMoveEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that is invoked when a treemap item is hovered over by the mouse.

Remarks

This event is useful to perform actions or visual changes in response to mouse movements over treemap items.

OnPrint

Triggers before the prints gets started.

Declaration

public EventCallback<PrintEventArgs> OnPrint { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PrintEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs before starting the print operation.

Remarks

This event allows you to make preparations or modifications before the print action begins.

OnRightClick

Triggers after right clicking on the treemap.

Declaration

public EventCallback<RightClickEventArgs> OnRightClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RightClickEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that is triggered when a right-click occurs on the treemap.

Remarks

Use this event to implement context menus or special actions tied to the right-click event.

Resizing

Triggers after resizing the treemap component.

Declaration

public EventCallback<ResizeEventArgs> Resizing { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeEventArgs>	An Microsoft.AspNetCore.Components.EventCallback<> invoked when the treemap is resized.

Remarks

This event is typically used to adjust elements and layouts in response to size changes.

TooltipRendering

Triggers on rendering of the tooltip in the treemap component.

Declaration

public EventCallback<TreeMapTooltipArgs> TooltipRendering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TreeMapTooltipArgs>	An Microsoft.AspNetCore.Components.EventCallback<> that occurs when rendering tooltips.

Remarks

This event allows customization of tooltip data and appearance before they are displayed.

Methods

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.