Class SfHeatMap<TValue>

Specifies the class for the heatmap component.

Inheritance

System.Object

SfBaseComponent

SfHeatMap<TValue>

Implements

IHeatMap

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

Namespace: Syncfusion.Blazor.HeatMap

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfHeatMap<TValue> : SfBaseComponent, IHeatMap

Type Parameters

Name
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	true, if the selection can be enabled. Otherwise, false.

BackgroundColor

Gets or sets the background color of the entire heatmap.

Declaration

public string BackgroundColor { get; set; }

Property Value

Type	Description
System.String	Accepts a string value specifying a color value. The value can be hex code, rgb, rgba string, and so on.

Remarks

This property allows you to change the background color of the HeatMap.

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	Accepts the CSS class string separated by space to customize the appearance of component.

DataSource

The DataSource provides the data to render the heatmap component.

Declaration

public TValue DataSource { get; set; }

Property Value

Type	Description
TValue	Binding data to the heatmap component.

EnableMultiSelect

Gets or sets a value indicating whether the user can select multiple cells in the HeatMap.

Declaration

public bool EnableMultiSelect { get; set; }

Property Value

Type	Description
System.Boolean	true to enable multiple selection of cells; otherwise, false to allow selection of a single cell. The default value is true.

Remarks

You can enable or disable the multiple cell selection through mouse, touch, or keyboard interactions in the Syncfusion.Blazor.HeatMap component.

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	Accepts the string value. The default value is 100%.

ID

Specifies ID property for the heatmap component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

Theme

Specifies the theme for heatmap.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme	Accepts a value from the Theme enum. The default value is Material.

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	Accepts the string value.

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
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
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()

OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

INotifyCollectionChanged event handler to track the changes in the HeatMap data source.

Declaration

protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)

Parameters

Type	Name	Description
System.String	propertyName	Observable property name.
System.Object	sender	Observable model object.
System.Boolean	isCollectionChanged	Sets true if the observable collection changed.
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	Changed Event Args

Overrides

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task

PrintAsync()

Method to print the heatmap component.

Declaration

public Task PrintAsync()

Returns

Type
System.Threading.Tasks.Task

RefreshBoundAsync()

Method to Refresh the heatmap component.

Declaration

public Task RefreshBoundAsync()

Returns

Type
System.Threading.Tasks.Task

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type
System.Boolean

UpdateChildProperties(String, Object)

Declaration

public void UpdateChildProperties(string key, object keyValue)

Parameters

Type	Name	Description
System.String	key
System.Object	keyValue

Implements

IHeatMap