This repository has been archived by the owner on Aug 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
heat_map.js
510 lines (431 loc) · 31 KB
/
heat_map.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
/**
* Copyright 2019 Bart Butenaers
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
module.exports = function(RED) {
var settings = RED.settings;
function HTML(config) {
// The configuration is a Javascript object, which needs to be converted to a JSON string
var configAsJson = JSON.stringify(config);
// Make sure to set the width and height via CSS style (instead of the width and height html element attributes).
// This way the dashboard can calculate the size of the div correctly. See:
// https://discourse.nodered.org/t/custom-ui-node-layout-problems/7731/21?u=bartbutenaers)
// When you need to debug the heatmap.js library, just replace heatmap.min.js by heatmap.js
var html = String.raw`
<script src="heatmap/js/heatmap.min.js"></script>
<div id="heatMapContainer_` + config.id + `" style="width:100%; height:100%;" ng-init='init(` + configAsJson + `)'></div>
<canvas id="heatMapLegend_` + config.id + `" style="width:100%; height:20px;" ng-show="legendType != 'none'" height="20px;">
`;
return html;
};
function checkConfig(node, conf) {
if (!conf || !conf.hasOwnProperty("group")) {
node.error(RED._("heat-map.error.no-group"));
return false;
}
return true;
}
var ui = undefined;
function HeatMapNode(config) {
try {
var node = this;
if(ui === undefined) {
ui = RED.require("node-red-dashboard")(RED);
}
RED.nodes.createNode(this, config);
if (checkConfig(node, config)) {
var html = HTML(config);
var done = ui.addWidget({
node: node,
group: config.group,
order: config.order,
width: config.width,
height: config.height,
format: html,
templateScope: "local",
emitOnlyNewValues: false,
forwardInputMessages: false,
storeFrontEndInputAsState: false,
convertBack: function (value) {
return value;
},
beforeEmit: function(msg, value) {
// ******************************************************************************************
// Server side validation of input messages.
// ******************************************************************************************
// Would like to ignore invalid input messages, but that seems not to possible in UI nodes:
// See https://discourse.nodered.org/t/custom-ui-node-not-visible-in-dashboard-sidebar/9666
// We will workaround it by sending a 'null' payload to the dashboard.
var configRows = parseInt(config.rows);
var configColumns = parseInt(config.columns);
// The row count might be specified in the input message
if (msg.rows != undefined) {
if (Number.isInteger(msg.rows)) {
configRows = msg.rows;
}
else {
console.log("The input msg.rows should be an integer number");
}
}
// The column count might be specified in the input message
if (msg.columns != undefined) {
if (Number.isInteger(msg.columns)) {
configColumns = msg.columns;
}
else {
console.log("The input msg.columns should be an integer number");
}
}
// When there is a payload, it should be an array.
// It could be that there is no payload, e.g. when only a background image is being set
if (msg.payload) {
if (!Array.isArray(msg.payload)) {
node.error("The msg.payload should contain an array");
msg.payload = null;
}
else if (msg.payload.length != parseInt(configRows) * parseInt(configColumns)) {
node.error("The length (" + msg.payload.length + ") of the array in msg.payload should be equal to rows (" +
configRows + ") x columns (" + configColumns + ")");
msg.payload = null;
}
else {
// For every cell in the grid we need a number, otherwise the heatmap cannot be calculated.
// Whether the value is a number or an object with one numeric property, doesn't really matter ...
for (var i = 0; i < msg.payload.length; i++) {
var arrayEntry = msg.payload[i];
// If the array entry is a number, then the entry can already be considered to be a valid value.
// When the entry isn't a number, it should be an object with 1 numeric property.
if (isNaN(arrayEntry)) {
var keys = Object.keys(arrayEntry);
if (keys.length != 1) {
node.error("Array element (index " + i + ") in msg.payload should be a number or an object with 1 (numeric) property");
msg.payload = null;
break;
}
if (isNaN(arrayEntry[keys[0]])) {
node.error("Array element (index " + i + ") in msg.payload should be an object with a numeric property value");
msg.payload = null;
break;
}
}
}
}
}
return { msg: msg };
},
beforeSend: function (msg, orig) {
if (orig) {
return orig.msg;
}
},
initController: function($scope, events) {
$scope.flag = true;
$scope.init = function (config) {
$scope.config = config;
// When no background or background image, then the background color should be transparent.
// Indeed we should be able to look through the background color to see what is behind it ...
if (config.backgroundType === "none" || config.backgroundType === "image") {
$scope.config.backgroundColor = "transparent";
}
// When the new 'legendType' property doesn't exist yet, we will migrate the value from the old 'showLegend' property
if (!$scope.config.legendType) {
if ($scope.config.showLegend === true) {
$scope.config.legendType = "vals";
}
else {
$scope.config.legendType = "none";
}
}
// When the new 'gridType' property doesn't exist yet, we will migrate the value from the old 'showValues' property
if (!$scope.config.gridType) {
if ($scope.config.showValues === true) {
$scope.config.gridType = "vals";
}
else {
$scope.config.gridType = "none";
}
}
}
$scope.$watch('msg', function(msg) {
// Ignore undefined messages.
if (!msg) {
return;
}
var parentDiv = document.getElementById('heatMapContainer_' + $scope.config.id);
// Create the heatmap canvas once. Don't do that it the $scope.init, because at that moment the width and height are still 0 ...
if (!$scope.heatMapInstance) {
// https://github.com/pa7/heatmap.js/blob/4e64f5ae5754c84fea363f0fcf24bea4795405ff/build/heatmap.js#L23
$scope.h337Config = {
container: parentDiv,
radius: parseInt($scope.config.radius || 40),
backgroundColor: $scope.config.backgroundColor || '#ffffff',
opacity: parseFloat($scope.config.opacity || 0.6),
//minOpacity: parseFloat($scope.config.minOpacity || 0),
//maxOpacity: parseFloat($scope.config.maxOpacity || 1),
blur: parseFloat($scope.config.blur || 0.85),
//gradient: { 0.25: "rgb(0,0,255)", 0.55: "rgb(0,255,0)", 0.85: "yellow", 1.0: "rgb(255,0,0)"},
renderer: $scope.config.defaultRenderer || 'canvas2d',
width: parentDiv.clientWidth,
height: parentDiv.clientHeight,
xField: 'x',
yField: 'y',
valueField: 'value',
plugins: {}
}
$scope.heatMapInstance = h337.create($scope.h337Config);
}
if ($scope.config.backgroundType === "image" && msg.image && typeof msg.image === 'string') {
// TODO Check whether other image types (png...) are also supported
parentDiv.style.backgroundImage = "url('data:image/jpg;base64," + msg.image + "')";
// Make sure the background image will fit inside the div, to avoid it will be repeated
parentDiv.style.backgroundSize = "100% 100%";
}
var configRows = $scope.config.rows;
var configColumns = $scope.config.columns;
// The row count might be specified in the input message
if (msg.rows != undefined) {
if (Number.isInteger(msg.rows)) {
configRows = msg.rows;
}
else {
console.log("The input msg.rows should be an integer number");
}
}
// The column count might be specified in the input message
if (msg.columns != undefined) {
if (Number.isInteger(msg.columns)) {
configColumns = msg.columns;
}
else {
console.log("The input msg.columns should be an integer number");
}
}
if (msg.payload && Array.isArray(msg.payload) && msg.payload.length === configRows * configColumns) {
var maxValue = 0;
var minValue = Number.MAX_VALUE;
var points = [];
var index = 0;
var columns = parseInt(configColumns);
var rows = parseInt(configRows);
// Calculate the width and height ratios, from the data matrix to the available canvas size.
// These ratio's are in fact the distance between the points ...
var ratioWidth = parentDiv.clientWidth / (columns + 1);
var ratioHeight = parentDiv.clientHeight / (rows + 1);
if ($scope.config.minMax === true) {
// When the minimum/maximum values are specified in the config screen, those values should be used
maxValue = parseFloat($scope.config.maximumValue);
minValue = parseFloat($scope.config.minimumValue);
}
else {
// When the minimum/maximum values are specified in the message, those values should be used
if (msg.maximum) {
maxValue = msg.maximum;
}
if (msg.minimum) {
minValue = msg.minimum;
}
}
// Determine the coordinates of every specified value.
// See https://www.patrick-wied.at/static/heatmapjs/example-minimal-config.html
for (var column = 1; column <= columns; column++) {
for (var row = 1; row <= rows; row++) {
var propertyKey = null;
var propertyValue = null; // numeric
var arrayEntry = msg.payload[index];
// We have already checked the input message, whether the data is correct for the specified gridType:
// When the value is not a number, the first property value will be a number
if (isNaN(arrayEntry)) {
propertyKey = Object.keys(arrayEntry)[0];
propertyValue = arrayEntry[propertyKey];
}
else {
propertyValue = arrayEntry;
}
// Calculate the minimum value, when not specified in the config screen or in the message
if ($scope.config.minMax === false && !msg.minimum) {
minValue = Math.min(minValue, propertyValue);
}
// Calculate the maximum value, when not specified in the config screen or in the message
if ($scope.config.minMax === false && !msg.maximum) {
maxValue = Math.max(maxValue, propertyValue);
}
// Calculate the coordinates of every value in the area of the parentDiv
var point = {
x: Math.floor(column * ratioWidth),
y: Math.floor(row * ratioHeight),
value: propertyValue,
key: propertyKey
}
points.push(point);
index++;
}
}
// The data for the heat map should contain all the information we have calculated
var data = { min: minValue, max: maxValue, data: points };
if ($scope.heatMapInstance._renderer._height === 0 || $scope.heatMapInstance._renderer._width === 0) {
// Under certain circumstances (e.g. when the node is redeployed) the following situation will occur:
// 1. A new $scope instance is created by AngularJs.
// 2. As a result scope.heatMapInstance will be undefined, so we will create a new heatmap instance (using h337.create ...).
// 3. However at that moment parentDiv.clientHeight is 0 ;-(
// 4. So the $scope.heatMapInstance._renderer._height will become 0.
// 5. When we call $scope.heatMapInstance.setData following error will occur:
// "app.min.js:148 DOMException: Failed to execute 'getImageData' on 'CanvasRenderingContext2D': The source height is 0"
// 6. The problem will continue to exist, until a new heatmap instance is created
// (since the $scope.heatMapInstance._renderer._height stays 0 until we call h337.create ...).
// 7. The console log will be filled with these errors, and NO heatmaps are drawed anymore!
//
// I haven't been able to avoid this situation, but merely a workaround has been implemented:
// 1. When we detect that the $scope.heatMapInstance._renderer._height is 0, we know that $scope.heatMapInstance.setData will fail.
// 2. Therefore we will determine the current parentDiv size, and pass this information to the heatmap instance.
// 3. As soon as a the height and width aren't 0 anymore, we can call $scope.heatMapInstance.setData again.
// It has no sense to call that function earlier, because it would fail anyway ...
$scope.h337Config.width = parentDiv.clientWidth;
$scope.h337Config.height = parentDiv.clientHeight;
// Apply the updated configuration and repaint
$scope.heatMapInstance.configure($scope.h337Config);
console.log("The heatmap height is being corrected");
}
// Refresh the heatmap content by setting new values (only when the height and width are not 0)
if ($scope.heatMapInstance._renderer._height !== 0 && $scope.heatMapInstance._renderer._width !== 0) {
$scope.heatMapInstance.setData(data);
}
else {
console.log("The heatmap is skipped due to invalid canvas size");
}
// Show the numeric input values on top of the heatmap
if ($scope.config.gridType !== "none") {
// Get a reference to the heatmap canvas, which has just been drawn in setData
var heatmapContext = parentDiv.firstElementChild.getContext('2d');
heatmapContext.font = "10px Arial";
heatmapContext.textAlign = "center";
heatmapContext.textBaseline = "middle";
// Draw now the values in the canvas, on top of the heatmap points
for (var i = 0; i < points.length; i++) {
var point = points[i];
var displayValue = "";
// When 'keys' need to be displayed but no key is available, then the numeric value will be showed
switch ($scope.config.gridType) {
case "keys":
if (point.key) {
displayValue = point.key;
}
else {
// When there is no key available, we will simply display nothing
displayValue = "";
}
break;
case "vals":
if (point.value) {
// Round the number to the specified number of decimals
displayValue = point.value.toFixed($scope.config.valuesDecimals || 0);
}
else {
// When there is no value available, we will simply display nothing
displayValue = "";
}
}
heatmapContext.fillText(displayValue, point.x, point.y);
}
}
// Show the legend, containing numeric values between minimum and maximum.
// The number of values that need to be displayed, has been specified in the config screen.
if ($scope.config.legendType === "vals") {
var legendCanvas = document.getElementById('heatMapLegend_' + $scope.config.id);
// Make sure the canvas size (width & height) match the size it is displayed on the screen (clientWidth & clientHeight).
// Indeed a canvas has 2 sizes:
// 1. The dimension of the pixels in the canvas (it's backing store or drawingBuffer) : set via DOM element attributes.
// This will set the size of the coordinate system that the canvas API will use.
// 2. The display size : set via CSS style attributes.
// This will be the actual size of the canvas element, that will be drawn on the page.
// Otherwise the numbers would be drawn at incorrect locations on the screen ...
/*if (legendCanvas.width !== legendCanvas.clientWidth || legendCanvas.height !== legendCanvas.clientHeight) {
legendCanvas.width = legendCanvas.clientWidth;
legendCanvas.height = legendCanvas.clientHeight;
}*/
ratioWidth = 1;
if (legendCanvas.clientWidth > 0) {
ratioWidth = legendCanvas.width / legendCanvas.clientWidth;
}
var legendContext = legendCanvas.getContext("2d");
legendContext.clearRect(0, 0, legendCanvas.clientWidth, legendCanvas.clientHeight);
legendContext.font = "18px Arial";
legendContext.textAlign = "center";
legendContext.textBaseline = "top";
var legendCount = parseInt($scope.config.legendCount) || 2;
var margin = 40;
// Show as many values as the user has specified.
for (var j = 0; j < legendCount; j++) {
// Calculate a fraction between 0 and 1
var fraction = j / (legendCount - 1);
// Calculate the numeric value, by interpolation between the minValue and maxValue
var value = (maxValue - minValue) * fraction + minValue;
// Calculate the color, by interpolation between blue ( rgb(0, 0, 255) ) and red ( rgb(255, 0 , 0) )
var red = (255 - 0) * fraction + 0;
var green = (0 - 0) * fraction + 0;
var blue = (0 - 255) * fraction + 255;
legendContext.fillStyle = "rgb(" + red + "," + green + "," + blue + ")";
var x = ((legendCanvas.clientWidth - 2 * margin) * fraction + margin) * ratioWidth;
var roundedValue = value.toFixed($scope.config.legendDecimals || 0);
legendContext.fillText(roundedValue, x, 5);
}
}
}
else {
console.log("The msg.payload is not an array of length " + configRows + " * " + configColumns);
}
if ($scope.config.image === "always" || ($scope.config.image === "request" && msg.snapshot === true)) {
// Get a reference to the heatmap.js canvas element
var heatmapCanvas = parentDiv.getElementsByClassName("heatmap-canvas")[0];
// Get the canvas as a jpeg image inside a data url (data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...9oADAMBAAIRAxEAPwD/AD/6AP/Z")
var dataUrl = heatmapCanvas.toDataURL('image/jpeg', 1.0); // 1.0 = full quality
// Get the base64 image from the data url
var base64Image = dataUrl.split(';base64,')[1];
$scope.send({payload: base64Image});
}
});
}
});
}
}
catch (e) {
// Server side errors
node.error(e);
console.trace(e); // stacktrace
}
node.on("close", function() {
if (done) {
done();
}
});
}
RED.nodes.registerType("ui_heat_map", HeatMapNode);
// By default the UI path in the settings.js file will be in comment:
// //ui: { path: "ui" },
// But as soon as the user has specified a custom UI path there, we will need to use that path:
// ui: { path: "mypath" },
var uiPath = ((RED.settings.ui || {}).path) || 'ui';
// Create the complete server-side path
uiPath = '/' + uiPath + '/heatmap/js/*';
// Replace a sequence of multiple slashes (e.g. // or ///) by a single one
uiPath = uiPath.replace(/\/+/g, '/');
// Make all the static resources from this node public available (i.e. heatmap.js or heatmap.min.js files).
RED.httpNode.get(uiPath, function(req, res){
var options = {
root: __dirname + '/lib/',
dotfiles: 'deny'
};
// Send the requested file to the client (in this case it will be heatmap.min.js)
res.sendFile(req.params[0], options)
});
}