Getting Started with Blazor HeatMap Chart in Blazor Server App

8 Jul 20266 minutes to read

This section briefly explains how to include Blazor HeatMap Chart component in a Blazor Server App using Visual Studio, Visual Studio Code, and the .NET CLI.

Create a new Blazor Server App

Create a Blazor Server App by using the Blazor Web App template in Visual Studio via Microsoft Templates or the Blazor Extension.

Run the following command to create a new Blazor Server App.

Terminal

dotnet new blazor -o BlazorApp --interactivity Server
cd BlazorApp

Alternatively, create a Blazor Server App using Visual Studio Code via Microsoft Templates or the Blazor Extension, or the C# Dev Kit extension.

Run the following command to create a new Blazor Server App.

Command Prompt

dotnet new blazor -o BlazorApp --interactivity Server
cd BlazorApp

NOTE

Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Server App. For detailed information, refer to the interactive render mode documentation.

Install the required Blazor package

Install the Syncfusion.Blazor.HeatMap NuGet package. All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.

Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
Search the required NuGet package (Syncfusion.Blazor.HeatMap) and install it.

Alternatively, you can install the same package using the Package Manager Console with the following command.

Package Manager Console

Install-Package Syncfusion.Blazor.HeatMap -Version 34.1.29

Open the terminal and run the following command.

Terminal

dotnet add package Syncfusion.Blazor.HeatMap -v 34.1.29

Open the command prompt and run the following command.

Command Prompt

dotnet add package Syncfusion.Blazor.HeatMap -v 34.1.29

Add import namespaces

After the packages are installed, open the ~/_Imports.razor file and import the Syncfusion.Blazor and Syncfusion.Blazor.HeatMap namespaces.

~/_Imports.razor
@using Syncfusion.Blazor
@using Syncfusion.Blazor.HeatMap

Register the Blazor service

Open the Program.cs file in Blazor Server App and register the Blazor service.

Program.cs
....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....

Add Script resources

The script can be accessed from NuGet through Static Web Assets. Include the script references in the App.razor file.

App.razor
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

Add Blazor HeatMap Chart component

Open a Razor file located in the ~/Pages/*.razor (for example, Home.razor) and add the Blazor HeatMap Chart component inside the razor file.

NOTE

If the interactivity location is set to Per page/component, define a render mode at the top of the razor file. (For example InteractiveServer). If the Interactivity is set to Global, the render mode is automatically configured in the App.razor file by default.

Home.razor
@rendermode InteractiveServer

<SfHeatMap DataSource="@HeatMapData">
    <HeatMapTitleSettings Text="Sales Revenue per Employee (in 1000 US$)"></HeatMapTitleSettings>
    <HeatMapCellSettings ShowLabel="true" TileType="CellType.Rect"></HeatMapCellSettings>
</SfHeatMap>

@code
{
    int[,] GetDefaultData()
    {
        int[,] dataSource = new int[,]
        {
            {52, 65, 67, 45, 37, 52},
            {68, 52, 63, 51, 30, 51},
            {7, 16, 47, 47, 88, 6},
            {66, 64, 46, 40, 47, 41},
            {14, 46, 97, 69, 69, 3},
            {54, 46, 61, 46, 40, 39}
        };
        return dataSource;
    }
    public object HeatMapData { get; set; }
    protected override void OnInitialized()
    {
        HeatMapData = GetDefaultData();
    }
}

Run the application

Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor HeatMap Chart component will render in your default web browser.