Heatmap

About 3 min read

TwHeatmap · Category: Charts

Settings

These settings are in the properties panel on the right while the widget is selected, mostly in the Heatmap Settings section. The default value is the value the widget has when it is first added to a page.

Source

Setting	Type	Default	Description
Source tag seriesConfigJson	Series configuration	[]	Pick a tag with an hourly history log. Only the first enabled source of the list is used. Templates apply their tag prefix.
Data mode	Selection	generic	Value: hourly sampled history value. Consumption: hourly consumption bucket (counter difference or sum of an instant log). Both use one-hour calendar buckets in the browser time zone. Options: generic Value (hourly history), consumption Consumption (hourly)
Aggregation valueType	Selection	avg	How the samples of one hour are combined in Value mode. Consumption mode always sums the hour. Options: avg Average, min Minimum, max Maximum, sum Sum

Time range

Setting	Type	Default	Description
Time source timeSource	Custom editor	local	Local: the widget uses its own range. Page time: follows the page time picker; without a selection it falls back to its own range.
Range type rangeMode	Selection	calendar	Calendar period (day, week, month) or a rolling window that ends now. At most 31 local days are shown. Options: calendar Calendar, relative Relative
Calendar period calendarPeriod	Selection	month	Period used when the range type is calendar. Options: day Day, week Week, month Month
Window length (minutes) timeRangeMinutes	Number	10080	Length of the rolling window in minutes (60 to 43200, at most 30 days).
Calendar offset calendarOffset	Number	0	0 is the current period, -1 the previous one. Future periods are not allowed.

Display

Setting	Type	Default	Description
Color scale minimum colorMin	Number	—	Fixed lower end of the color scale. Leave both ends empty to follow the smallest and largest value of the data.
Decimals decimals	Number	2	Decimal places of the values in the tooltip and the color scale (0 to 6).
Color scale maximum colorMax	Number	—	Fixed upper end of the color scale. It applies only together with the minimum and must be larger.
Show color scale showVisualMap	Checkbox	On	Shows the color scale below the matrix.

Other settings

Setting	Type	Default	Description
Enable Flashing enableFlashing	Checkbox	Off	Makes the widget blink (an opacity pulse every second). Usually bound to an alarm condition.
Log Button logButton	Checkbox	Off	At runtime shows a chart icon when hovering the widget; clicking it adds the Tags bound to the widget to the log Tag list.

Bindings

In the Bindings (Rules) section of the properties panel, a Tag can be bound to the following properties of this widget with a Direct binding. The binding types (Direct, IntRange, FloatRange, Boolean, Bit) are the same for all widgets; they are described on the Widget Reference page.

title, visible, authorization, x, y, width, height, rotation, class, foregroundColor, backgroundColor, borderColor, borderStyle, borderWidth, borderRadius, borderTopLeftRadius, borderTopRightRadius, enableFlashing, logButton, heatmapSchemaVersion, seriesConfigJson, mode, valueType, timeSource, rangeMode, calendarPeriod, calendarOffset, timeRangeMinutes, colorMin, colorMax, decimals, showVisualMap

Common sections

While this widget is selected, the properties panel also shows these common sections: General, Layout, Appearance, Bindings (Rules). These sections are described on the Page Editor page.