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

Design View

In the visual editor, you can find the Heat Map icon under the Charts component palette group.

You can drag and drop the widget in the grid, and then according to your needs configure the following sub-elements:

Metric: the metric whose current value must be displayed within the gauge box.

Code View

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


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

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

<heat-map-widget>

PROPERTIES

CSS Class

The name(s) of the CSS class used to customize the widget layout.
Type: STRING | Optional
class="my-custom-class"

Data Source

The source of the data to load and agrregate into the heatmap.
Type: ENUM | Optional | Values:

MetricDataProvider

WorkSessionDataProvider

[config]="{dataProvider: 'WorkSessionDataProvider'}"

Max Value Color

The color associated to the maximum value into the heat map.
Type: STRING | Optional | Default: #08B05B
[config]="{maxColor: 'fooBar'}"

Min Value Color

The color associated to the minimun value into the heat map.
Type: STRING | Optional | Default: #FFFFFF
[config]="{minColor: 'fooBar'}"

Title

The title displayed on the top part of the widget box.
Type: STRING | Optional
[title]="'Details'"

Visibility Condition

The expression that allows you to reduce the visibility of the element.
Type: STRING | Optional
*ngIf="getUser().organizationId != null"

SUB-ELEMENTS

Metric

The metric whose current value must be displayed within the gauge box.
single | mandatory

<metric name="Temperature"></metric>

PROPERTIES

Filter

The name of the filter used to transform and display values.
Type: FILTER | Optional
filter="fooBarFilter"

Label

The metric alternative label.
Type: STRING | Optional
label="Temperature"

Name

The metric whose value(s) must be loaded by the widget.
Type: METRIC | Mandatory
name="Temperature"

Unit

The unit of measurement to be displayed along the value.
Type: STRING | Optional
unit="°C"

Visibility Condition

The expression that allows you to reduce the visibility of the element.
Type: STRING | Optional
*ngIf="getUser().organizationId != null"