Class HeatMapCellSettings

Specifies the heatmap cell settings.

Inheritance
System.Object
HeatMapCellSettings
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class HeatMapCellSettings : OwningComponentBase

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
public BubbleType BubbleType { get; set; }
Property Value
Type
BubbleType

EnableCellHighlighting

Enable or disable the cell highlighting on mouse hover.

Declaration
public bool EnableCellHighlighting { get; set; }
Property Value
Type
System.Boolean

Format

Specifies the formatting options for the data label.

Declaration
public string Format { get; set; }
Property Value
Type
System.String

IsInversedBubbleSize

Enable or disable the bubble to display in inverse.

Declaration
public bool IsInversedBubbleSize { get; set; }
Property Value
Type
System.Boolean

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
public RenderFragment<object> LabelTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.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
public bool ShowLabel { get; set; }
Property Value
Type
System.Boolean

TileType

Defines cell Type. They are.

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

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

Declaration
protected override Task OnInitializedAsync()
Returns
Type
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
System.Threading.Tasks.Task