forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
4.3._node-red_editor.html
299 lines (191 loc) · 12.3 KB
/
4.3._node-red_editor.html
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Node-RED Editor — BPA/OpenIAP Docs 1.0.5 documentation</title>
<script type="text/javascript" src="static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script src="static/jquery.js"></script>
<script src="static/underscore.js"></script>
<script src="static/doctools.js"></script>
<script src="static/language_data.js"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/styles.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> BPA/OpenIAP Docs
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rpa.html">1. <strong>Introduction to RPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openflow.html">2. <strong>OpenFlow</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openrpa.html">3. <strong>OpenRPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="node_red.html">4. <strong>Node-RED</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_a.html">5. <strong>Appendix A</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_b.html">6. <strong>Appendix B</strong></a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="license.html">1. License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BPA/OpenIAP Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><strong>Node-RED Editor</strong></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="node-red-editor">
<h1><strong>Node-RED Editor</strong><a class="headerlink" href="#node-red-editor" title="Permalink to this headline">¶</a></h1>
<p>The editor window is where all the work gets done. It contains four components: header, palette, workspace and sidebar.</p>
<div class="figure align-center" id="id3">
<img alt="images/nodered_editor_default_components.png" src="images/nodered_editor_default_components.png" />
<p class="caption"><span class="caption-text">Node-RED Components.</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h2>
<p>The header contains the deploy button, main menu, and, if user authentication is activated, the user menu.</p>
<div class="section" id="deploy-button">
<h3>Deploy Button<a class="headerlink" href="#deploy-button" title="Permalink to this headline">¶</a></h3>
<p>The deploy button is used to deploy flows once you have finished creating or editing them. It is important to remark that you must always deploy a flow after editing it so the changes are applied.</p>
</div>
<div class="section" id="main-menu">
<h3>Main Menu<a class="headerlink" href="#main-menu" title="Permalink to this headline">¶</a></h3>
<p>The main menu contains many actions, such as hiding components, importing or exporting flows, searching for flows, actions (like add, rename and delete) flows and subflows, manage palettes, settings, keyboard shortcuts and a link to Node-RED’s webpage.</p>
</div>
<div class="section" id="user-menu">
<h3>User Menu<a class="headerlink" href="#user-menu" title="Permalink to this headline">¶</a></h3>
<p>The user menu, if the user is authenticated, shows your username and the option to logout.</p>
</div>
</div>
<div class="section" id="palette">
<h2>Palette<a class="headerlink" href="#palette" title="Permalink to this headline">¶</a></h2>
<p>The palette contains all of the nodes that are installed and available to use. These nodes are organized into a number of categories, which can be expanded or collapsed by clicking its header.</p>
<p>The entire palette can be hidden by clicking the toggle button that is shown when the mouse is over it or by pressing <strong>Ctrl+p</strong>.¹</p>
<p>¹ - <a class="reference external" href="https://nodered.org/docs/user-guide/editor/palette/">Palette</a> (<a class="reference external" href="https://nodered.org/docs/user-guide/editor/palette/">https://nodered.org/docs/user-guide/editor/palette/</a>)</p>
<div class="figure align-default" id="id4">
<a class="reference internal image-reference" href="images/nodered_editor_palette.png"><img alt="images/nodered_editor_palette.png" src="images/nodered_editor_palette.png" style="width: 180.0px; height: 760.0px;" /></a>
<p class="caption"><span class="caption-text">Node-RED Editor Palette.</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="workspace">
<h2>Workspace<a class="headerlink" href="#workspace" title="Permalink to this headline">¶</a></h2>
<p>The main workspace is where flows are developed by dragging nodes from the palette and wiring them together.</p>
<p>The workspace has a row of tabs along the top; one for each flow and any subflows that have been opened. ²</p>
<div class="figure align-center" id="id5">
<img alt="images/nodered_editor_workspace.png" src="images/nodered_editor_workspace.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Workspace.</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="view-tools">
<h3>View Tools<a class="headerlink" href="#view-tools" title="Permalink to this headline">¶</a></h3>
<p>The footer of the workspace contains buttons to zoom in and out as well as to reset the default zoom level. It also contains a toggle button for the view navigator.</p>
<p>To zoom in, either click the <strong>+</strong> button inside the view navigator or press <strong>Ctrl+=</strong>.</p>
<p>To zoom out, either click the <strong>-</strong> button inside the view navigator or press <strong>Ctrl+-</strong>.</p>
<p>To reset the zoom, either click the <strong>O</strong> button inside the view navigator or press <strong>Ctrl+0</strong>.</p>
<p>The view navigator provides a scaled down view of the entire workspace, highlighting the area currently visible. That area can be dragged around the navigator to quickly jump to other parts of the workspace. It is also useful for finding nodes that have been <strong>lost</strong> to the further edges of the workspace.</p>
<div class="figure align-center" id="id6">
<img alt="images/node_red_workspace_navigator_active.png" src="images/node_red_workspace_navigator_active.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Workspace Navigator Active.</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="customising-the-view">
<h3>Customising the view<a class="headerlink" href="#customising-the-view" title="Permalink to this headline">¶</a></h3>
<p>The workspace view can be customised via the <strong>View</strong> tab of the User Settings dialog.</p>
<p>To activate the User Settings dialog, press <strong>Ctrl+,</strong>.</p>
<div class="figure align-center" id="id7">
<img alt="images/nodered_editor_user_settings_dialog.png" src="images/nodered_editor_user_settings_dialog.png" />
<p class="caption"><span class="caption-text">Node-RED Editor User Settings Dialog.</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
</div>
<p>² - <a class="reference external" href="https://nodered.org/docs/user-guide/editor/workspace/">Workspace</a> (<a class="reference external" href="https://nodered.org/docs/user-guide/editor/workspace/">https://nodered.org/docs/user-guide/editor/workspace/</a>)</p>
</div>
</div>
<div class="section" id="sidebar">
<h2>Sidebar<a class="headerlink" href="#sidebar" title="Permalink to this headline">¶</a></h2>
<p>The sidebar contains panels that provide a number of useful tools within the editor.³</p>
<ul>
<li><p><strong>Information</strong></p>
<blockquote>
<div><p>View information about nodes and their help info</p>
</div></blockquote>
</li>
<li><p><strong>Debug</strong></p>
<blockquote>
<div><p>View messages passed into debug nodes</p>
</div></blockquote>
</li>
<li><p><strong>Configuration Nodes</strong></p>
<blockquote>
<div><p>Manage configuration nodes</p>
</div></blockquote>
</li>
<li><p><strong>Context Data</strong></p>
<blockquote>
<div><p>View the contents of the context variables</p>
</div></blockquote>
</li>
</ul>
<div class="figure align-center" id="id8">
<img alt="images/nodered_editor_sidebar.png" src="images/nodered_editor_sidebar.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Sidebar.</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
</div>
<p>Some nodes contribute their own sidebar panels, such as <a class="reference external" href="https://flows.nodered.org/node/node-red-dashboard/">node-red-dashboard</a> (<a class="reference external" href="https://flows.nodered.org/node/node-red-dashboard">https://flows.nodered.org/node/node-red-dashboard</a>).</p>
<p>The panels are opened by clicking their icon in the header of the sidebar, or by selecting them in the drop-down list shown.</p>
<p>The sidebar can be resized by dragging tis edge across the workspace.</p>
<p>If the edge is dragged close to the right-hand edge, the sidebar will be hidden. It can be shown again by selecting the <strong>Show sidebar</strong> option in the View menu, or using the <strong>Ctrl+Space</strong> shortcut.</p>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Thiago Pestitschek, Diego Thijssen, Tiago Bentivoglio, Paulo Veras
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<p>Powered by <a href="https://bpatechnologies.com/">BPA Technologies</a></p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<h4>>Powered by BPA Technologies - bpatechnologies.com</h4>
</body>
</html>