bigml-nodered/package.html

BigML bindings for Nodered

<style>
.bigml_node_label { fill: white; }
#palette-BigML .palette_node { color: white; }
#red-ui-palette-BigML .red-ui-palette-label { color: white; }
</style>

<script type="text/javascript">
  
  RED.nodes.registerType('package', {
  category: 'BigML',
  color: '#454957',
  defaults: {"name":{"value":"WhizzML Package","required":true},"meta_url":{},"meta_input":{"value":""},"meta":{"value":true}},
  inputs:1,
  outputs:1,
  inputLabels: '[]',
  outputLabels: 'result',
  icon: 'icon_generic.png',
  label: function() {
    return this.name || 'WhizzML Package';
  },
  labelStyle: function() {
    return this.name?"bigml_node_label":"";
  },
  });
</script>

<script type="text/x-red" data-template-name="package">
      <div class="form-row">
        <label for="node-input-name">
            <i class="icon-tag"></i> Name
        </label>
        <input type=text id=node-input-name  value='WhizzML Package'>
    </div>
    <div class="form-row">
        <label for="node-input-meta_url">
            <i class="icon-tag"></i> Meta URL
        </label>
        <input type=text id=node-input-meta_url placeholder='https://raw.githubusercontent.com/whizzml/examples/master/cross-validation/' >
    </div>
    <div class="form-row">
        <label for="node-input-meta_input">
            <i class="icon-tag"></i> Meta input
        </label>
        <input type=text id=node-input-meta_input placeholder='[["key", "value"]]' >
    </div>
    <div class="form-row">
        <label for="node-input-meta">
            <i class="icon-tag"></i> Meta
        </label>
        <input type=checkbox id=node-input-meta  value='true'>
    </div>
</script>

<script type="text/html" data-help-name="package">

<p>This is a BigML Nodered node.</p>

<h3>Details</h3>
<p>This node support all inputs defined in
  <a href='https://bigml.com/api/packages' target=blank>BigML REST
  API</a>. By default, it expects to receive
  a <code>[]</code> input (see below for more details) and
  it will output the <code>result</code> field of the created
  resource.
</p>
<p>However, you can override default inputs and outputs by defining
  the node port label so they match the desired input or output as
  specified below.</p>
<p>Only when the node is used with the <code>reify</code> option
  enabled, it will actually hit BigML and do its work there. This
  generally means some resources will be created and sent through as
  node outputs.</p>
<p>When the node is used with the <code>reify</code>option disabled,
  it will generate WhizzML code and send it through to the next node
  in the flow without hitting BigML. All WhizzML code created by this
  node (and others) when not in <code>reify</code> mode is accumulated
  and executed as a single WhizzML script by the first
  downstream <code>reified</code> node.</p>

<h3>Inputs</h3>
    <dl class="message-properties">
            <dt>Name
            <span class="property-type">:text</span>
        </dt>
        <dd></dd>

        <dt>Meta URL
            <span class="property-type">:text</span>
        </dt>
        <dd>The URL of the WhizzML package to execute.</dd>

        <dt>Meta input
            <span class="property-type">:json</span>
        </dt>
        <dd>A JSON representing the inputs for the package. </dd>

        <dt>Meta
            <span class="property-type">:boolean</span>
        </dt>
        <dd></dd>

    </dl>

<h3>Outputs</h3>
     <ol class="node-ports">
             <dl class="message-properties">
                 <dt>payload <span class="property-type">string or
                 JSON</span></dt>
                 <dd>the <code>result</code> of the created
                 BigML entity.</dd>
                 <dt>whizzml <span class="property-type">string</dt>
                 <dd>(only for <code>reified</code> nodes) the
                 generated WhizzML code which is fed into the next
                 node.
                 <dt>wzStack <span class="property-type">object</dt>
                 <dd>(only for <code>reified</code> nodes) private.
             </dl>
     </ol>

</script>