Class SfHeatMap<TValue>

Specifies the class for the heatmap component.

Inheritance
System.Object
SfBaseComponent
SfHeatMap<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfHeatMap<TValue> : SfBaseComponent, IHeatMap
Type Parameters
Name Description
TValue

Constructors

SfHeatMap()

Declaration
public SfHeatMap()

Properties

AllowSelection

The AllowSelection provides an option to enable or disable the selection of multiple cells in the heatmap component.

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

CellSettings

The CellSettings provides an option to customize the heatmap cell.

Declaration
public HeatMapCellSettings CellSettings { get; set; }
Property Value
Type Description
HeatMapCellSettings

CssClass

The CssClass property is used to add a user-preferred class name in the root element of the HeatMap, that can be used to customize the component (both CSS and functionality customization)

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

DataSource

The DataSource provides the data to render the heatmap component.

Declaration
public TValue DataSource { get; set; }
Property Value
Type Description
TValue

DataSourceSettings

The DataSourceSettings specifies the datasource settings for the heatmap component.

Declaration
public HeatMapDataSourceSettings DataSourceSettings { get; set; }
Property Value
Type Description
HeatMapDataSourceSettings

EnablePersistence

Enable or disable persisting component's state between page reloads.

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

Height

The height of the HeatMap as a string accepts input as both '100px' or '100%'. If specified as '100%, HeatMap renders to the full height of its parent element.

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

HtmlAttributes

Specify the HtmlAttributes for heatmap component.

Declaration
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Specifies ID property for the heatmap component.

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

LegendSettings

The LegendSettings provides an option for customizing the legend of the heatmap component.

Declaration
public HeatMapLegendSettings LegendSettings { get; set; }
Property Value
Type Description
HeatMapLegendSettings

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

Margin

The Margin provides an option to customize the left, right, top and bottom margins of the heatmap component.

Declaration
public HeatMapMargin Margin { get; set; }
Property Value
Type Description
HeatMapMargin

PaletteSettings

The PaletteSettings provides an option for customizing the cell color of the heatmap component.

Declaration
public HeatMapPaletteSettings PaletteSettings { get; set; }
Property Value
Type Description
HeatMapPaletteSettings

RenderingMode

Specifies the rendering mode.

  • SVG:HeatMap is rendered using SVG draw mode.
  • Canvas:HeatMap is rendered using Canvas draw mode.
  • Auto:Automatically switch the draw mode based on the number of records in the data source.
Declaration
public DrawType RenderingMode { get; set; }
Property Value
Type Description
DrawType

ShowTooltip

Enable or disable the tooltip for the heatmap component.

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

Theme

Specifies the theme for heatmap.

Declaration
public Theme Theme { get; set; }
Property Value
Type Description
Theme

TitleSettings

Specifies the Title of the heatmap component.

Declaration
public HeatMapTitleSettings TitleSettings { get; set; }
Property Value
Type Description
HeatMapTitleSettings

TooltipSettings

The TooltipSettings provides an option for customizing the ToolTipSettings property of the heatmap component.

Declaration
public HeatMapTooltipSettings TooltipSettings { get; set; }
Property Value
Type Description
HeatMapTooltipSettings

Width

The width of the HeatMap as a string accepts input as both '100px' or '100%'. If specified as '100%, HeatMap renders to the full width of its parent element.

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

XAxis

The XAxis provides an option to configure the horizontal axis.

Declaration
public HeatMapXAxis XAxis { get; set; }
Property Value
Type Description
HeatMapXAxis

YAxis

The YAxis provides an option to configure the vertical axis.

Declaration
public HeatMapYAxis YAxis { get; set; }
Property Value
Type Description
HeatMapYAxis

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

ClearSelectionAsync()

To clear the multi-cell selection.

Declaration
public Task ClearSelectionAsync()
Returns
Type Description
System.Threading.Tasks.Task

ExportAsync(ExportType, String, Nullable<PdfPageOrientation>, Boolean)

Handles the export method for the heatmap component.

Declaration
public Task ExportAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true)
Parameters
Type Name Description
ExportType type
System.String fileName
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation> orientation
System.Boolean allowDownload
Returns
Type Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender
Returns
Type Description
System.Threading.Tasks.Task
Overrides

OnInitializedAsync()

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

OnParametersSetAsync()

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

PrintAsync()

Method to print the heatmap component.

Declaration
public Task PrintAsync()
Returns
Type Description
System.Threading.Tasks.Task

RefreshBoundAsync()

Method to Refresh the heatmap component.

Declaration
public Task RefreshBoundAsync()
Returns
Type Description
System.Threading.Tasks.Task

UpdateChildProperties(String, Object)

Declaration
public void UpdateChildProperties(string key, object keyValue)
Parameters
Type Name Description
System.String key
System.Object keyValue

Implements