Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfHeatMap<TValue> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    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)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    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

    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

    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

    ID

    Specifies ID property for the heatmap component.

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

    Theme

    Specifies the theme for heatmap.

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

    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

    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
    SfBaseComponent.OnAfterRenderAsync(Boolean)

    OnInitializedAsync()

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

    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

    ShouldRender()

    Declaration
    protected override bool ShouldRender()
    Returns
    Type Description
    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
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved