Class SfHeatMap<TValue>

Specifies the class for the heatmap component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfHeatMap<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.HeatMap
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfHeatMap<TValue> : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, 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
[Parameter]
public bool AllowSelection { get; set; }
Property Value
Type Description
bool

true, if the selection can be enabled. Otherwise, false.

BackgroundColor

Gets or sets the background color of the entire heatmap.

Declaration
[Parameter]
public string BackgroundColor { get; set; }
Property Value
Type Description
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
[Parameter]
public string CssClass { get; set; }
Property Value
Type Description
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
[Parameter]
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
[Parameter]
public bool EnableMultiSelect { get; set; }
Property Value
Type Description
bool

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
[Parameter]
public string Height { get; set; }
Property Value
Type Description
string

Accepts the string value. The default value is 100%.

ID

Specifies ID property for the heatmap component.

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

Accepts the string value. The default value is empty.

Theme

Specifies the theme for heatmap.

Declaration
[Parameter]
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
[Parameter]
public string Width { get; set; }
Property Value
Type Description
string

Accepts the string value.

Methods

BuildRenderTree(RenderTreeBuilder)

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

ClearSelectionAsync()

To clear the multi-cell selection.

Declaration
public Task ClearSelectionAsync()
Returns
Type
Task

ExportAsync(ExportType, string, PdfPageOrientation?, bool)

Handles the export method for the heatmap component.

Declaration
public Task ExportAsync(ExportType type, string fileName, PdfPageOrientation? orientation = null, bool allowDownload = true)
Parameters
Type Name Description
ExportType type
string fileName
PdfPageOrientation? orientation
bool allowDownload
Returns
Type
Task

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered.

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender

Set to true for the first time component rendering; otherwise gets false.
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnObservableChange(string, object, bool, 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
string propertyName

Observable property name.
object sender

Observable model object.
bool isCollectionChanged

Sets true if the observable collection changed.
NotifyCollectionChangedEventArgs e

Changed Event Args
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

PrintAsync()

Method to print the heatmap component.

Declaration
public Task PrintAsync()
Returns
Type
Task

RefreshBoundAsync()

Method to Refresh the heatmap component.

Declaration
public Task RefreshBoundAsync()
Returns
Type
Task

ShouldRender()

Declaration
protected override bool ShouldRender()
Returns
Type
bool
Overrides

UpdateChildProperties(string, object)

Declaration
public void UpdateChildProperties(string key, object keyValue)
Parameters
Type Name Description
string key
object keyValue

Implements