mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
af71ae649b
* initial support of BATCH node * add concat mode & fix for docs and js code * add tests for BATCH node * minor correction of typo * allow interval in float * fixed message catalog * add test for too many pending messages & related fixes * update info document on batchMaxKeptMsgsCount * fixed close callback * fixed info document * add initial topics entry of concat mode
193 lines
8.3 KiB
HTML
193 lines
8.3 KiB
HTML
<!--
|
|
Copyright JS Foundation and other contributors, http://js.foundation
|
|
|
|
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.
|
|
-->
|
|
|
|
<!DOCTYPE html>
|
|
|
|
<script type="text/x-red" data-template-name="batch">
|
|
<div class="form-row">
|
|
<label for="node-input-mode"><i class="fa fa-dot-circle-o"></i> <span data-i18n="batch.mode.label"></span></label>
|
|
<select type="text" id="node-input-mode" style="width: 300px;">
|
|
<option value="count" data-i18n="batch.mode.num-msgs"></option>
|
|
<option value="interval" data-i18n="batch.mode.interval"></option>
|
|
<option value="concat" data-i18n="batch.mode.concat"></option>
|
|
</select>
|
|
</div>
|
|
|
|
<div class="node-row-msg-count">
|
|
<div class="form-row node-row-count">
|
|
<label for="node-input-count" data-i18n="batch.count.label"></label>
|
|
<input type="text" id="node-input-count" data-i18n="[placeholder]batch.count.count" style="width: 50px;">
|
|
</div>
|
|
</div>
|
|
|
|
<div class="node-row-msg-overwrap">
|
|
<div class="form-row node-row-overwrap">
|
|
<label for="node-input-count" data-i18n="batch.count.overwrap"></label>
|
|
<input type="text" id="node-input-overwrap" data-i18n="[placeholder]batch.count.count" style="width: 50px;">
|
|
</div>
|
|
</div>
|
|
|
|
<div class="node-row-msg-interval">
|
|
<div class="form-row node-row-interval">
|
|
<label for="node-input-interval"> <span data-i18n="batch.interval.label"></span></label>
|
|
<input type="text" id="node-input-interval" data-i18n="[placeholder]batch.interval.seconds" style="width: 50px;">
|
|
<span data-i18n="batch.interval.sec"></span>
|
|
</div>
|
|
<div class="form-row">
|
|
<input type="checkbox" id="node-input-allowEmptySequence" style="margin-left:10px; vertical-align:top; width:auto;">
|
|
<label for="node-input-allowEmptySequence" style="width:auto;" data-i18n="batch.interval.empty"></label>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="node-row-msg-concat">
|
|
<div class="form-row">
|
|
<label data-i18n="batch.concat.topics-label"></label>
|
|
<div class="form-row node-input-topics-container-row">
|
|
<ol id="node-input-topics-container"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="form-row">
|
|
<label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
|
|
<input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
|
|
</div>
|
|
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="batch">
|
|
<p>A function that divides input messages into multiple sequences of messages or concatenates multiple sequences of messages into a single messages sequence.</p>
|
|
<h3>Details</h3>
|
|
<h4>group by number of messages</h4>
|
|
<p>groups incoming messages into sequences of messages with specified counts. The output message group can be overwrapped.</p>
|
|
<h4>group by interval in seconds</h4>
|
|
<p>groups incoming messages received withn specified interval into sequences of messages. </p>
|
|
<h4>concatenate message groups</h4>
|
|
<p>creates a message sequence based on <code>topic</code> value of incoming message sequences.</p>
|
|
<p>Target and order of concatenated sequences are specified by <code>Topics</code> value. Selection of concatenated message groups is based on arrival of first message of the group.</p>
|
|
<p><b>Note:</b> This node internally keeps messages for its operation. In order to prevent unexpected memory usage, maximum number of messages kept can be specified. Default is no limit on number of messages.
|
|
<ul>
|
|
<li><code>batchMaxKeptMsgsCount</code> property set in <b>settings.js</b>.</li>
|
|
</ul>
|
|
</p>
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
RED.nodes.registerType("batch",{
|
|
category: "function",
|
|
color:"#E2D96E",
|
|
defaults: {
|
|
name: {value:""},
|
|
mode: {value:"count"},
|
|
count: {value:10},
|
|
overwrap: {value:0},
|
|
interval: {value:10},
|
|
allowEmptySequence: {value:false},
|
|
topics: {value:[{topic:""}]}
|
|
},
|
|
inputs:1,
|
|
outputs:1,
|
|
icon: "batch.png",
|
|
label: function() {
|
|
return this.name || "batch";
|
|
},
|
|
labelStyle: function() {
|
|
return this.name ? "node_label_italic" : "";
|
|
},
|
|
oneditprepare: function() {
|
|
var node = this;
|
|
var topic_str = node._("batch.concat.topic");
|
|
|
|
function resizeTopics(topic) {
|
|
var newWidth = topic.width();
|
|
topic.find('.red-ui-typedInput')
|
|
.typedInput("width",newWidth-15);
|
|
}
|
|
|
|
$("#node-input-topics-container")
|
|
.css('min-height','200px').css('min-width','430px')
|
|
.editableList({
|
|
addItem: function(container, i, opt) {
|
|
if (!opt.hasOwnProperty('topic')) {
|
|
opt.topic = "";
|
|
}
|
|
var row = $('<div/>').appendTo(container);
|
|
var valueField = $('<input/>',{
|
|
class:"node-input-topic-value",
|
|
type:"text",
|
|
style:"margin-left: 5px;"
|
|
}).appendTo(row)
|
|
.typedInput({default:'str', types:['str']});
|
|
valueField.typedInput('value', opt.topic);
|
|
valueField.typedInput('type', 'str');
|
|
valueField.attr('placeholder', topic_str);
|
|
resizeTopics(container);
|
|
},
|
|
resizeItem: resizeTopics,
|
|
sortable: true,
|
|
removable: true
|
|
});
|
|
|
|
$("#node-input-count").spinner({
|
|
});
|
|
$("#node-input-overwrap").spinner({
|
|
});
|
|
$("#node-input-interval").spinner({
|
|
});
|
|
$("#node-input-mode").change(function(e) {
|
|
var val = $(this).val();
|
|
$(".node-row-msg-count").toggle(val==="count");
|
|
$(".node-row-msg-overwrap").toggle(val==="count");
|
|
$(".node-row-msg-interval").toggle(val==="interval");
|
|
$(".node-row-msg-concat").toggle(val==="concat");
|
|
if (val==="concat") {
|
|
var topics = node.topics;
|
|
var container = $("#node-input-topics-container");
|
|
container.editableList('empty');
|
|
for (var i = 0; i < topics.length; i++) {
|
|
var topic = topics[i];
|
|
container.editableList('addItem', topic);
|
|
}
|
|
}
|
|
});
|
|
},
|
|
oneditsave: function() {
|
|
var topics = $("#node-input-topics-container").editableList('items');
|
|
var node = this;
|
|
node.topics = [];
|
|
topics.each(function(i) {
|
|
var topicData = $(this).data('data');
|
|
var topic = $(this);
|
|
var vf = topic.find(".node-input-topic-value");
|
|
var value = vf.typedInput('value');
|
|
var type = vf.typedInput('type');
|
|
var r = {topic:value};
|
|
node.topics.push(r);
|
|
});
|
|
},
|
|
oneditresize: function(size) {
|
|
var rows = $("#dialog-form>div:not(.node-input-topics-container-row)");
|
|
var height = size.height;
|
|
for (var i = 0; i < rows.size(); i++) {
|
|
height -= $(rows[i]).outerHeight(true);
|
|
}
|
|
var editorRow = $("#dialog-form>div.node-input-topics-container-row");
|
|
height -= (parseInt(editorRow.css("marginTop"))+parseInt(editorRow.css("marginBottom")));
|
|
$("#node-input-topics-container").editableList('height',height);
|
|
}
|
|
});
|
|
</script>
|