Reference

Application

The nodeworks application provides basic functionality for creating and running sheets. Multiple sheets can be opened and edited simultaneously by using the tabs. The buttons on the main tool bar will only effect the currently visible sheet.

../_images/overview.png

Main Toolbar

The Main Toolbar is at the top of the window and contains buttons that effect the currently visible sheet. These buttons include:

Icon

Description

menu

Open the main menu.

save

Save the current sheet.

open

Open a node chart.

run

Run the current sheet.

step

Step through the sheet node by node.

stop

Stop a currently running sheet.

auto

Automatically run as nodes are added.

debug

Enable debug mode.

zoom_in

Zoom in.

zoom_out

Zoom out.

zoom_reset

Reset the zoom.

overscan

Show all nodes.

wand

Open Node Wizard.

map

Show/hide mini-map.

infooutline

Show/hide help.

camera

Save an image of the sheet.

Keyboard Shortcuts

List of keyboard shortcuts at the application level.

Note

On OSX (Mac) use Command instead of Ctrl.

Shortcut

Description

Ctrl + O

Open a sheet.

Ctrl + N

Create a new, blank sheet (tab).

Ctrl + T

Create a new, blank sheet (tab).

Ctrl + S

Save current sheet (tab).

Ctrl + W

Close current sheet (tab).

Ctrl + Delete

Close current sheet (tab).

Sheet (Node chart)

The sheet is the main work area where nodes are added and connected.

Adding nodes

There are two ways to add nodes to the sheet:

  1. Right-Click - Right-click on the sheet where you would like to add a node and go to the Add Node menu for a list of all the nodes.

  2. Search - Left-click on the sheet where you would like to add a node and use the keyboard to search for a node. A search bar and list of matches will automatically be displayed.

Sheet View

The currently displayed view of the sheet in the window can be changed. The keyboard arrow keys can be used to move the view left, right, up, and down. The view can also be moved by holding the mouse scroll wheel and dragging the view around.

The sheet view can be zoomed in and out by holding control on the keyboard while scrolling the mouse wheel up and down.

Highlighting

A single node or connection can be selected by left clicking on the object. Multiple objects can be selected by left clicking on the sheet and dragging a selection box around the objects. Holding control on the keyboard also allows for multiple selections or deselection with the left mouse button. A selected object will have an outline placed around it.

Right-Click Menu

Right-clicking on the sheet opens a context menu with several options.

Menu Entry

Description

Show All

Zooms the sheet to fit all nodes in the window.

Copy

Create a copy of the currently selected node(s) and/or connection(s).

Cut

Copies the selected object(s) and deletes the original(s).

Paste

Creates and places any copied object(s) onto the sheet.

Select All

Select all objects in the sheet.

Delete

Delete the currently selected object(s).

Group

Places the currently selected objects into a group node.

Refresh Nodes

Refreshes the current node library.

Add Node

Context menu for nodes in the node library.

Keyboard Shortcuts

List of keyboard shortcuts at the sheet level.

Shortcut

Description

Ctrl + C

Copy the selected object(s).

Ctrl + X

Cut the selected object(s).

Ctrl + V

Paste any copied object(s).

Ctrl + A

Select all objects on the sheet.

Delete

Delete the selected object(s).

Ctrl + G

Places the currently selected objects into a group node.

Ctrl + R

Refreshes the current node library.

Nodes

Each node has a set of common features. These features include renaming, displaying error messages, toggling force run, expanding/collapsing, and resizing.

../_images/node_common.png

Moving Nodes

Hovering over the top portion of a node turns the pointer into a hand icon. Left clicking the mouse and holding allows for movement of the node. Multiple objects that have been selected can also be moved together.

../_images/move.gif

Rename

The name of a node in the sheet can be changed. After double-clicking on the name at the top of a node, a blank line edit with the blinking cursor appears. Simply type in the line to replace the node name.

../_images/rename.gif

Error messages

The error icon will be enabled and highlighted red if the node encountered an error. Clicking on the icon will open a dialog displaying the error message.

Force run

Nodes attempt to be intelligent when re-running a sheet. By default nodes will check the input connections to see if the input values have changed. If they have changed, then the node will run. If the input values have not changed, then the node will not run.

Sometimes this feature is not desirable. The node can be always executed, regardless of whether or not the inputs have changed by toggling the Force run button.

Expand/collapse

Once a node has been set up, it can be convenient to “collapse” the node into a more compact form factor. When the node is “collapsed”, only terminals that have connections will be displayed. All other terminals that are not connected and other widgets will be hidden.

Resize

The size of a node in the sheet can be changed. Clicking and holding on the lower right corner of a node will reshape the node based on mouse movement. There is a minimum size allowed for each node.

../_images/resize.gif

Flip Terminals

The terminals on a node can be flipped (inputs on the right side and outputs on the left side) by selecting Flip Terminals on the right-click menu.

Right-Click Menu

Right-clicking at the top of a node opens a context menu with several options for the node.

Menu Entry

Description

Show Error

Displays the error encountered if node failed to execute.

Expand Terminals

Expands the node terminals to reveal any that were hidden.

Hide Terminals

Hides node terminals and reduces node size.

Flip Terminals

Reverses sides that input/output terminals are on.

Help

Pop-up window containing documentation for node.

Force Run

Forces the selected node to process when sheet is run.

Connections

Connections are created by clicking on a terminal pad, dragging the mouse to another terminal and releasing the mouse. Connections can be selected and deleted be pressing the delete button. The location on the connection can be controlled with control points.

Adding Control Points

A control point can be added to a connection by double clicking anywhere on the connection. This control point can be selected and moved about the sheet like a node. This can help reduce screen clutter by removing connection overlap on nodes.

../_images/crtl_pt.gif

Flipping Control Points

Control points can flipped (reverse the in and out sides) by right-clicking on the point. Use this feature to make connections go from right to left instead of from the standard left to right.

../_images/flip_ctrl_pt.gif

Connection and Terminal Colors

Connection and terminals are colored based on the type of data being passed through them. Connections and terminals may not properly update the color until the sheet has been run to when actual data is passed.

Data Type

Color

Integer

Blue

Float

Orange

Boolean

Green

String

Red

List

Purple

Dictionary

Brown

Set

Pink

Numpy Array

Grey

Pandas DataFrame

Yellow

Default

Turquoise