Component Guide 5: Displays and Controls

From Nova Documentation
Jump to: navigation, search

Graph

Help comp disp graph.png

A Graph display is used to display results of a simulation. A Graph has the capability to display multiple series / variables simultaneously. You can also compare the results of different simulations on the same graph.

Usage: To add a Graph to a model, select the Graph tool in the component palette and then click on either the model canvas or the dashboard. Two objects will appear – a graph stub on the model canvas, and the graph display on the dashboard. The graph display and stub are linked, like two sides of the same coin. They don’t move together, but they represent the same graph object. The purpose of the stub on the model canvas is to provide a way to connect the graph to other objects in the model and set its properties. You can have multiple graph objects in one model, and you can have graph objects on different levels of a multi-level model. In addition, a graph display can have multiple pages or tabs. All graph stubs look identical, but you can tell them apart by looking at the name. The graph display in the dashboard can be resized by grabbing the little handle on the bottom right.

Graph-properties.png
Properties
Right-click to view and set graph properties.
  • Graph Title. Enter a title for the graph, which will appear next to it on both the model canvas as well as the dashboard.*
  • Page size. Set the number of pages (or tabs) in the graph.
  • Page. Pick the graph page/tab to customize, starting with 0 for the first page. For example, if a graph object has 2 pages (Page size = 2), then the numbers in Page will be either 0 or 1. When Page=0, you are changing the Properties for the first page / tab. When you change Page=1, now the property shown are for the second page.
  • Pin button. If the pushpin button is depressed, the graph will always appear on the dashboard at every level above the current level. This is only relevant if the Nova project has more than one level.
  • Refresh rate. The refresh date determines the number of time steps between redraws of the graph. With the default value 1, the graph is refreshed at every time step.
  • Display. Enter the first and last time to display on the graph. In a time series graph, time appears on the x-axis
  • Full Time Interval. If checked graph display entire interval specified by Display
  • Graph Type. Select the type of graph: time series, scatter, bar, or 3D scatter [Currently unavailable]. If the graph type is ‘Scatter’, the ‘Connect Dots’ checkbox will be enabled so you can decide whether or not to connect the dots.
  • Select Contents. The box on the left lists all of the model objects that can be plotted on the graph (objects don’t have to be connected with an arrow). Icons indicate what type of object (term, stock, etc.) each variable is. Select one or more variables and click the >>> button to put them in the list of series that will be display on the right. To remove a variable from the graph, select the variable name in the right-hand pane and click the <<< button. Then lick ‘OK’.
  • Color picker. To change the color for a series in the Graph, select the name of the variable in the right-hand pane, then click the color picker (sample color next to ‘Scale’).
  • Scale / Low / High. These properties determine the range of the y-axis. The default setting for ‘Scale’ is ‘Auto’, meaning the graph object will select the upper and lower bounds for the y-axis based on the data. If more than one variable / series is plotted, each variable will have its own individually scaled y-axis (even if the data ranges are nearly identical). To manually enter low and high values for an individual variable, click on the name of the variable in the right-hand pane. If the model has run already, the low and high values for this variable will appear in the boxes on the bottom. Change the scale to ‘Self’, and then enter values for the Low and High values click “Set” to save the changes.
  • Alias. The alias is the label that will appear in the legend. To change the alias, click on one of the variables in the graph in the right-hand pane, type in an Alias, then click ‘Set’.
Graph Display
  • Normal / compare. Graph displays have two modes. In ‘normal’ mode, each time the model is run the graph is redrawn. In ‘compare’ mode, each time the model is run the new data is plotted on the graph but the previous data is not erased. If the y-axis scale is set to ‘auto’, data already on the graph will be redrawn to fit the new scale. To erase the graph contents in either compare or normal mode, click the ‘Load’ button.
  • Save data. Click this button to save the data in the graph to a csv file.
  • Identifying exact values. After a model has been run, exact values on the display can be viewed by clicking in the graph area and moving the mouse to the desired point on the horizontal axis.
  • Zooming. Zoom in on the graph by highlighting the portion of the graph you wish to see with the mouse. [How to zoom out?]
Connections

Graph objects don’t have to be manually connected to other objects in the model with an arrow. Once an object has been setup for display in a graph, a dotted line will be drawn to illustrate which object the graph is displaying. If you want to display the results of a mathematical expression (e.g., the sum of two stocks), add a Term object with the expression and then display the Term object in the Graph.

Table

Help comp disp table.png

A Table operates much like a Graph, but instead of visually showing results as the model runs a Table returns the actual numbers. These numbers can be exported to a csv file for further analysis.

Usage: To add a Table display to a model, select the Table tool from the component palette and then click on eitherthe model canvas or the dashboard where you want the table to appear. Two objects will appear – a table icon on the model canvas, and the Table display on the dashboard. The Table icon and display don’t move together but they represent the same Table object. The purpose of the icon on the model canvas is to provide a way to see which objects are displayed in Table, and to set its properties. You can have more then one table display in a model, and a single Table display can show the outputs of several objects in the model. The table display in the dashboard can be resized by grabbing the little handle on the bottom right.


Help comp disp table prope-300x181.png
Properties
Right-click to view and set Table properties.
  • Table Title. Enter a title for the Table, which will appear next to it on both the model canvas as well as the dashboard.
  • Page Size. Set the number of pages (or tabs) in the table.
  • Page. Pick the page/tab to customize, starting with 0 for the first page.
  • Pushpin button. If the pushpin button is depressed, the Table will always appear on the dashboard at the current level or above. This is only relevant if the Nova project has more than one level.
  • Select Contents. The box on the left lists all of the model objects that can be shown in the Table (objects don’t have to be connected to the Table with an arrow to appear in the list). Select one or more of the objects and click the >>> button to put them in the list of objects that will be displayed. To remove a variable from the Table, select the variable name in the right-hand pane and click the <<< button. Then click ‘OK’.
  • Alias. The alias is the label that will appear in the tab. To change the alias, click on one of the objects in the right-hand pane, enter an Alias, then click ‘Set’.
  • Refresh rate. The refresh date determines the number of time steps between redraws of the Table. With the default value 1, the Table is refreshed at every time step.

Tableau

Tableau example.png

The Tableau Plug-in is a matrix that allows values to be entered and stored for use.

Usage
To add a Tableau display to a model, select the Tableau tool from the Plug-in palette and then click on either the model canvas or the dashboard where you want the Tableau matrix to appear. Two objects will appear – a Tableau icon on the model canvas, and the Tableau display on the dashboard. The Tableau icon and display don’t move together but they represent the same Tableau object. The purpose of the icon on the model canvas is to provide a way to see what values are in each element of the Tableau matrix, and to set its properties. You can have more then one Tableau display in a model. The Tableau display in the dashboard can be resized by grabbing the little handle on the bottom right. Note: the Tableau Plug-in has a default value.
Example

An example of usage can be found here.


Properties
Right-click to view and set Tableau properties.
  • Rows. Specify the number of rows (i).
  • Columns. Specify the number of columns (j).
  • Row Height. Specify the visible height of the row(s).
  • Column Width. Specify the visible width of the column(s).

Slider

Help comp ctrl slider.png

Usage: To add a Slider control to your model, select the Slider tool in the component palette and then click on either the model canvas or the dashboard. When you add a Slider, two objects will appear – a slider icon on the model canvas, and the Slider control on the dashboard. These two visual elements represent the same Slider. You can have multiple Sliders on a model, as long as each one is given a unique name.

Unlike some objects, you don’t need to manually connect Sliders to other objects to use them in expressions. Sliders ‘broadcast’ their value wirelessly to all objects in the model, including displays. Sliders can only vary their value along a linear scale. To adjust a parameter value along a non-linear scale (e.g., logarithmic), create a Term object with an expression that uses the value of the Slider object (see also Spinners below).


Help comp ctl slider prop-300x233.png
Properties
Right-click to view and set Slider properties
  • Low / hi. Enter the lower and upper bound for the Slider.
  • Decimal places. Select the number of decimal places by which the value will change when the slider control is dragged with the mouse.
  • Pushpin button. If the pushpin button is depressed, the Slider will always appear on the dashboard from the current level to the top. This is only relevant if the Nova project has more than one level.
  • Comment. You can enter a comment to record notes about the Slider and what you were thinking when you added it to the model


Spinner

Spinners.png
A Spinner is a visual control that allows you to change the value of a parameter in your model using the mouse. Unlike a Slider, which is similar but limited to a changing values along a linear scale, a Spinner has the ability to also change values using Scientific Notation.

Usage To add a Spinner to your model, select the Spinner tool on the component palette and then click on either the model canvas or the dashboard. When you add a Spinner, two objects will appear – an icon for the Spinner on the model canvas, and the Spinner control on the dashboard. These two visual elements represent the same Spinner – changing the properties of one changes the properties of the other. You can have multiple Spinners on a model, as long as each one is given a unique name. You don’t need to manually connect Spinners to other objects to use them in expressions. Like Sliders, Spinners ‘broadcast’ their value wirelessly to all objects in the model.

Help comp ctrl spinner prop1-259x300.png
Properties
Right-click to view or set the Spinner properties.
  • Low / hi. Enter the lower and upper bound for the Spinner.
  • Decimal places. Select the number of decimal places by which the value will change when the Spinner control is changed with the mouse.
  • Pushpin button. If the pushpin button is depressed, the Spinner control will always appear on the dashboard from the current level to the top. This is only relevant if the Nova project has more than one level.
  • Exponent. When Exponent=1, the Spinner varies along a linear scale. For other values, Exponent sets the variable e in the following equation:
 m * be
Where m and e are both changeable in the Spinner control.
When Exponent is greater than 1, an additional Spinner for the variable e appears in the control, and additional properties for the e parameter can be set, as shown below.

width=300xpx width=100xpx