Class HeatMapCellSettings

Specifies the heatmap cell settings.

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

Constructors

HeatMapCellSettings()

Declaration
public HeatMapCellSettings()

Properties

BubbleType

Defines Bubble Type. They are

  • Size:Defines the bubble type as size.
  • Color:Defines the bubble type as color.
  • Sector:Defines the bubble type as sector.
  • SizeAndColor:Defines the bubble type as size and color.
Declaration
[Parameter]
public BubbleType BubbleType { get; set; }
Property Value
Type
BubbleType

EnableCellHighlighting

Enable or disable the cell highlighting on mouse hover.

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

Format

Specifies the formatting options for the data label.

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

IsInversedBubbleSize

Enable or disable the bubble to display in inverse.

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

LabelTemplate

Gets or sets the HTML template that will be used to display any HTML elements that represent the value of the cell in the HeatMap.

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

Accepts template content which can be any HTML element. The default value is null.
Remarks

In the cells, you can display custom elements like images and HTML layouts.

Examples
<SfHeatMap DataSource="@(new int?[1, 1] { { 8 } })">
   <HeatMapXAxis Labels="@(new string[] { "Jan" })"></HeatMapXAxis>
   <HeatMapYAxis Labels="@(new string[] { "Mon" })"></HeatMapYAxis>
<HeatMapCellSettings>
       <LabelTemplate>
           @{
               Dictionary<string, string> content = context as Dictionary<string, string>;
               <div>@content["Value"]</div>
           }
       </LabelTemplate>
   </HeatMapCellSettings>
</SfHeatMap>

ShowLabel

Toggles the visibility of data label over the heatmap cells.

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

TileType

Defines cell Type. They are.

  • Rect:Render heatmap cells in rectangle shape.
  • Bubble:Render heatmap cells in bubble shape.
Declaration
[Parameter]
public CellType TileType { get; set; }
Property Value
Type
CellType

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()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements