Skip to content

Commit

Permalink
Add note re live internet connection required
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave Conway-Jones committed Aug 26, 2019
1 parent 2e94dda commit 031e003
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
10 changes: 6 additions & 4 deletions node-red-node-ui-vega/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
node-red-node-ui-vega
=====================

Node-RED Dashboard widget node for declarative data visualization using [Vega visualization grammar](https://vega.github.io/vega/).
A Node-RED Dashboard widget node for declarative data visualization using [Vega visualization grammar](https://vega.github.io/vega/). It also support the Vega-lite specification.

![Vega Node Examples](https://raw.githubusercontent.com/node-red/node-red-ui-nodes/master/node-red-node-ui-vega/figs/vega-example.png)

**Note**: This node requires a live internet connection in order to load the required libraries via CDN.

Install
-------

Run the following command in your Node-RED user directory - typically `~/.node-red`
Either use the Editor - Menu - Manage Palette - Install option, or run the following command in your Node-RED user directory (typically `~/.node-red`) after installing Node-RED-dashboard.

npm install node-red-node-ui-vega

Expand All @@ -27,6 +29,6 @@ Vega/Vega-Lite specification in JSON format can be specified on node settings me
Example
-------

You can find some examples of Vega node from Node-RED editor menu:
There are several examples that you can import from the Node-RED editor menu:

**Import > Examples > ui vega**
**Import > Examples > node-red-node-ui-vega**
12 changes: 7 additions & 5 deletions node-red-node-ui-vega/locales/en-US/ui_vega.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<script type="text/x-red" data-help-name="ui_vega">
<p>Node-RED widget node for visualizing data using <a href="https://vega.github.io/vega/">Vega visualization grammar</a>.</p>
<p>A Node-RED-Dashboard widget node for visualizing data using <a href="https://vega.github.io/vega/">Vega visualization grammar</a>.</p>

<h3>Inputs</h3>
<dl class="message-properties">
<dt>payload<span class="property-type">object</span></dt>
<dd>vega specification</dt>
<dd>vega specification (json)</dt>
</dl>

<h3>Details</h3>
<p>This UI widget can be used to visualize data using <a href="https://vega.github.io/vega/">Vega visualization grammar</a>.</p>
<p>Vega specification can be specified by <b>Vega Specification</b> propertie in settings panel or <code>payload</code> property of input message. If both properties are set input message takes precedence.</p>
<p>The node accepts <a href="https://vega.github.io/vega/">Vega</a> and <a href="https://vega.github.io/vega-lite/">Vega-Lite</a> specification.</p>
<p>This UI widget can be used to visualize data using the <a href="https://vega.github.io/vega/">Vega visualization grammar</a>.</p>
<p>Vega specification can be set either by the <b>Vega Specification</b> property in settings panel, or by the <code>payload</code> property of the input message.
If both properties are set the input message takes precedence.</p>
<p>The node accepts both <a href="https://vega.github.io/vega/">Vega</a> and <a href="https://vega.github.io/vega-lite/">Vega-Lite</a> specification.</p>
<p><b>Note</b>: This node requires a live internet connection in order to load the required libraries.</p>
</script>

0 comments on commit 031e003

Please sign in to comment.