HelpBot Assistant

How can I help you?

Getting started with Angular HeatMap chart component

9 Feb 202624 minutes to read

This section explains the steps required to create a HeatMap and demonstrates the basic usage of the HeatMap component.

You can explore some useful features in the HeatMap component with the following video.

Set up the Angular Application

Prerequisites: Node.js (LTS) and npm must be installed before creating an Angular project.

Use the Angular CLI to create and manage Angular applications. Install the CLI with one of the following approaches depending on preference.

npm install -g @angular/cli

Once the Angular CLI is installed, create a new Angular application by running the following command.

ng new my-app
cd my-app

Installing Syncfusion® HeatMap package

Syncfusion® packages are published on npm under the @syncfusion scope. The Angular distribution is available in two package formats:

Currently, Syncfusion® provides two types of package structures for Angular components,

  1. Ivy library distribution package format
  2. Angular compatibility compiler (ngcc) package for legacy compilation and rendering

Ivy library distribution package

Syncfusion® Angular packages(>=20.2.36) use the Ivy distribution to support the Angular Ivy rendering engine. These packages are compatible with Angular version 21 and other latest angular versions. Install the Ivy package with the following command:

Add @syncfusion/ej2-angular-heatmap package to the application.

npm install @syncfusion/ej2-angular-heatmap --save

Angular compatibility compiled package (ngcc)

For Angular version below 12, you can use the legacy (ngcc) package of the Syncfusion® Angular components. To download the ngcc package use the below.

Add @syncfusion/ej2-angular-heatmap@ngcc package to the application.

npm install @syncfusion/ej2-angular-heatmap@ngcc --save

To reference the ngcc package in package.json, add the -ngcc suffix to the package version, for example:

@syncfusion/ej2-angular-heatmap:"32.1.19-ngcc"

Note: If the -ngcc suffix is not specified, the Ivy package will be installed and a compatibility warning may appear when using older Angular versions.

Add HeatMap component

After installing the package, you need to add the HeatMap component to your application. To do this, modify the template in the app.component.ts file to render the <ejs-heatmap> component. Also, ensure the HeatMapModule is imported to register the component.

The following example demonstrates how to add a basic HeatMap to the application.

import { HeatMapModule, HeatMapAllModule} from '@syncfusion/ej2-angular-heatmap'
import { Component, ViewEncapsulation } from '@angular/core';

@Component({
imports: [
         HeatMapModule, HeatMapAllModule
    ],
    standalone: true,
    selector: 'my-app',
    // specifies the template string for the HeatMap component
    template: `<ejs-heatmap id="heatmap-container"></ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {

}

Now use the my-app in the index.html instead of default one.

  <my-app></my-app>

Use the npm run start command to run the application in the browser.

  npm start

The below example shows a basic HeatMap.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule} from '@syncfusion/ej2-angular-heatmap'



import { Component, ViewEncapsulation } from '@angular/core';

@Component({
imports: [
         HeatMapModule
    ],
standalone: true,
    selector: 'my-app',
    // specifies the template string for the HeatMap component
    template: `<ejs-heatmap id="heatmap-container"></ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {

}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Module injection

The heat map components are segregated into individual feature-wise modules. To use its feature, you need to inject its feature module using the HeatMap.Inject() method. In the current application,the basic heat map is modified to visualize sales revenue data for week, and the tooltip and legend features of the heat map are used. Find the relevant feature modules and descriptions as follows.

  • LegendService - Provides the legend feature by injecting it.
  • TooltipService - Provides the tooltip feature by injecting it.

Now, import the above-mentioned modules from the heat map package and inject them into the heat map component as follows.

 
    import { HeatMapModule, HeatMapAllModule, LegendService, TooltipService } from '@syncfusion/ej2-angular-heatmap'
    import { Component } from '@angular/core';

    @Component({
        imports: [
            HeatMapModule, HeatMapAllModul
        ],
        standalone: true,
        providers: [ LegendService, TooltipService ]
    })

Populate heat map with data

This section explains how to populate the following two-dimensional array data to the heat map.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule } from '@syncfusion/ej2-angular-heatmap'




import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],

standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;" [dataSource]='dataSource'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
    }
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Enable axis labels

You can add axis labels to the heat map and format those labels using the xAxis and yAxis properties. Axis labels provide additional information about the data points populated in the heat map.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule} from '@syncfusion/ej2-angular-heatmap'




import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;" [dataSource]='dataSource' [xAxis]='xAxis' [yAxis]='yAxis'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
        // Data for heatmap
        dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add heat map title

Add a title using the titleSettings property to the heat map to provide quick information to the user about the data populated in the heat map.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule} from '@syncfusion/ej2-angular-heatmap'




import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;"  [titleSettings]='titleSettings' [dataSource]='dataSource' [xAxis]='xAxis' [yAxis]='yAxis'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
     titleSettings: Object = {
        text: 'Sales Revenue per Employee (in 1000 US$)',
        textStyle: {
            size: '15px',
            fontWeight: '500',
            fontStyle: 'Normal'
        }
    };
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Enable legend

Use a legend for the heat map in the legendSettings object by setting the visible property to true and injecting the Legend module using the HeatMap.Inject(Legend) method.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule, LegendService } from '@syncfusion/ej2-angular-heatmap'




import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],

providers: [LegendService],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;"  [titleSettings]='titleSettings' [dataSource]='dataSource'
       [xAxis]='xAxis' [yAxis]='yAxis' [legendSettings]='legendSettings'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
     titleSettings: Object = {
        text: 'Sales Revenue per Employee (in 1000 US$)',
        textStyle: {
            size: '15px',
            fontWeight: '500',
            fontStyle: 'Normal'
        }
    };
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
    public legendSettings: Object = {
        visible:true,
        position: 'Right',
        showLabel:true,
        height:'150px'
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add data label

Add data labels to improve the readability of the heat map. This can be achieved by setting the showLabel property to true in the cellSettings object.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule, LegendService } from '@syncfusion/ej2-angular-heatmap'



import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],

providers: [ LegendService],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;" [cellSettings]='cellSettings' [titleSettings]='titleSettings' [dataSource]='dataSource'
       [xAxis]='xAxis' [yAxis]='yAxis' [legendSettings]='legendSettings'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
     titleSettings: Object = {
        text: 'Sales Revenue per Employee (in 1000 US$)',
        textStyle: {
            size: '15px',
            fontWeight: '500',
            fontStyle: 'Normal'
        }
    };
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
    public legendSettings: Object = {
        visible:true,
        position: 'Right',
        showLabel:true,
        height:'150px'
    };
    public cellSettings: Object = {
        showLabel: true,
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add custom cell palette

The default palette settings of the heat map cells can be customized by using the paletteSettings property. Using the palette property in paletteSettings object, you can change the color set for the cells. You can change the color mode of the cells to fixed or gradient mode using the type property.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule, LegendService } from '@syncfusion/ej2-angular-heatmap'



import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],

providers: [LegendService],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;" [paletteSettings]='paletteSettings'
       [cellSettings]='cellSettings' [titleSettings]='titleSettings' [dataSource]='dataSource'
       [xAxis]='xAxis' [yAxis]='yAxis' [legendSettings]='legendSettings'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
     titleSettings: Object = {
        text: 'Sales Revenue per Employee (in 1000 US$)',
        textStyle: {
            size: '15px',
            fontWeight: '500',
            fontStyle: 'Normal'
        }
    };
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
    public legendSettings: Object = {
        visible:true,
        position: 'Right',
        showLabel:true,
        height:'150px'
    };
    public cellSettings: Object = {
        showLabel: true,
    };
     public paletteSettings: Object = {
        palette: [{ value: 0, color: '#C06C84' },
        { value: 50, color: '#6C5B7B' },
        { value: 100, color: '#355C7D' },
        ]
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Enable tooltip

The tooltip is used when you cannot display information by using the data labels due to space constraints. You can enable the tooltip by setting the showTooltip property to true and injecting the Tooltip module using the HeatMap.Inject(Tooltip) method.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { HeatMapModule} from '@syncfusion/ej2-angular-heatmap'
import { LegendService, TooltipService} from '@syncfusion/ej2-angular-heatmap'



import { Component, ViewEncapsulation } from '@angular/core';
import { HeatMap } from '@syncfusion/ej2-heatmap';

@Component({
imports: [
         HeatMapModule
    ],

providers: [ LegendService, TooltipService],
standalone: true,
    selector: 'my-app',
    template:
       `<ejs-heatmap id='container' style="display:block;" showTooltip='true' [paletteSettings]='paletteSettings'
       [cellSettings]='cellSettings' [titleSettings]='titleSettings' [dataSource]='dataSource'
       [xAxis]='xAxis' [yAxis]='yAxis' [legendSettings]='legendSettings'>
        </ejs-heatmap>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent{
     titleSettings: Object = {
        text: 'Sales Revenue per Employee (in 1000 US$)',
        textStyle: {
            size: '15px',
            fontWeight: '500',
            fontStyle: 'Normal'
        }
    };
        // Data for heatmap
         dataSource: Object[] = [
           [73, 39, 26, 39, 94, 0],
           [93, 58, 53, 38, 26, 68],
           [99, 28, 22, 4, 66, 90],
           [14, 26, 97, 69, 69, 3],
           [7, 46, 47, 47, 88, 6],
           [41, 55, 73, 23, 3, 79],
           [56, 69, 21, 86, 3, 33],
           [45, 7, 53, 81, 95, 79],
           [60, 77, 74, 68, 88, 51],
           [25, 25, 10, 12, 78, 14],
           [25, 56, 55, 58, 12, 82],
           [74, 33, 88, 23, 86, 59]
        ];
        xAxis: Object = {
        labels: ['Nancy', 'Andrew', 'Janet', 'Margaret', 'Steven', 'Michael', 'Robert',
            'Laura', 'Anne', 'Paul', 'Karin', 'Mario'],
    };
    yAxis: Object = {
        labels: ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'],
    };
    public legendSettings: Object = {
        visible:true,
        position: 'Right',
        showLabel:true,
        height:'150px'
    };
    public cellSettings: Object = {
        showLabel: true,
    };
     public paletteSettings: Object = {
        palette: [{ value: 0, color: '#C06C84' },
        { value: 50, color: '#6C5B7B' },
        { value: 100, color: '#355C7D' },
        ]
    };
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

You can refer to our Angular HeatMap Chart feature tour page for its groundbreaking feature representations. You can also explore our Angular HeatMap Chart example that shows how to render the HeatMap Chart in Angular.