---
title: "Heat Map"
slug: "heat-map-widget"
updated: 2026-04-17T07:25:35Z
published: 2026-04-17T07:25:35Z
canonical: "learn.servitly.com/heat-map-widget"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://learn.servitly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Heat Map

Displays a day and hours heat map with metric values, alerts, or work-sessions data.

![Heat Map](https://components-manager.servitly.com/components/HeatMap_1/IMAGES/_screenshot?owner=AG_Servitly)

## Template Syntax

Below you can find some examples of how to use the component within a template.

```xml

            <heat-map-widget [title]="'Pieces by hour'">
            <metric name="pieces"></metric>
            </heat-map-widget>
        
```

## Component Reference

Here is a comprehensive list of all the elements and properties that can be used to configure the component.

#### Heat Map `&lt;heat-map-widget&gt;`

| *Data Source* | The source of the data to load and agrregate into the heatmap. **Name**: config.dataProvider **Type**: ENUM \| Optional **Values**: *MetricDataProvider*, *WorkSessionDataProvider* **Default Value**: *WorkSessionDataProvider* `[config]="{dataProvider: 'MetricDataProvider'}"` |
| --- | --- |
| *Max Value Color* | The color associated to the maximum value into the heat map. **Name**: config.maxColor **Type**: STRING \| Optional **Default Value**: *#08B05B* `[config]="{maxColor: '#007BFF'}"` |
| *Min Value Color* | The color associated to the minimun value into the heat map. **Name**: config.minColor **Type**: STRING \| Optional **Default Value**: *#FFFFFF* `[config]="{minColor: '#007BFF'}"` |
| *Title* | The title displayed on the top part of the widget box. **Name**: title **Type**: STRING \| Optional `[title]="'Heat Map'"` |
| **Rendering** |
| *Availability* | Configure availability based on active features on Digital Plan on Add-ons **Name**: hasFeature **Type**: FEATURE (multiple) \| Optional `[hasFeature]="['feature_a', 'feature_b']"` |
| *CSS Class* | The name(s) of the CSS class used to customize the widget layout. **Name**: class **Type**: STRING \| Optional `class="my-custom-class"` |
| *Visibility Condition* | The expression that allows you to reduce the visibility of the element. **Name**: *ngIf **Type**: STRING \| Optional `*ngIf="getUser().organizationId != null"` |
| **Sub Elements** |
| [*Metric*](/docs/heat-map-widget/#metric) | The metric whose current value must be displayed within the gauge box. |

#### Metric `&lt;metric&gt;`

| *Filter* | The name of the filter used to transform and display values. **Name**: filter **Type**: FILTER \| Optional `filter="fooBarFilter"` |
| --- | --- |
| *Label* | The metric alternative label. **Name**: label **Type**: STRING \| Optional `label="Temperature"` |
| *Name* | The metric whose value(s) must be loaded by the widget. **Name**: name **Type**: METRIC \| Required `name="Temperature"` |
| *Unit* | The unit of measurement to be displayed along the value. **Name**: unit **Type**: STRING \| Optional `unit="&amp;deg;C"` |
| **Advanced** |
| *Visibility Condition* | The expression that allows you to reduce the visibility of the element. **Name**: *ngIf **Type**: STRING \| Optional `*ngIf="getUser().organizationId != null"` |

## Full Syntax Example

```xml

<heat-map-widget    
    [title]="'Heat Map'"
    [config]="{
        minColor: '#007BFF',
        dataProvider: 'MetricDataProvider',
        maxColor: '#007BFF'
    }"
    class="my-custom-class"
    *ngIf="getUser().organizationId != null"
    hasFeature="['feature_a', 'feature_b']">
    <metric        
            name="Temperature"
            label="Temperature"
            filter="fooBarFilter"
            unit="&deg;C"
            *ngIf="getUser().organizationId != null"></metric>
</heat-map-widget>
```