Class HeatMapTooltipSettings

Specifies the heatmap tooltip settings.

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

Constructors

HeatMapTooltipSettings()

Declaration
public HeatMapTooltipSettings()

Properties

Enable

Enables / Disables the visibility of the tooltip.

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

Fill

Specifies the color collection for heatmap cell.

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

Header

Specifies the header for the tooltip.

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

Template

Specifies the custom template to format the tooltip content.

Declaration
[Parameter]
public RenderFragment<object> Template { get; set; }
Property Value
Type
RenderFragment<object>

Methods

BuildRenderTree(RenderTreeBuilder)

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

Dispose(bool)

Releases resources used by the component.

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

True to release managed and unmanaged resources; otherwise, false.
Overrides

OnInitializedAsync()

Initializes the component and registers tooltip settings with the parent heat map.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

OnParametersSetAsync()

Applies parameter changes and notifies the heat map when tooltip settings change.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

Implements