labels are custom variables that you can specify on the object. For example, if you want to keep track of the number of flowitems of itemtype 3 that have entered an object, you can use a label to keep a record of this value. Use the commands setlabel(), getlabel(), and label() to interact with labels you have created. More information on these commands is found in the command summary.
The main panel shows a list of the labels on this object.
- Adds a new label with number or string data to the end of the list of labels.
- Duplicates the selected label(s).
- Deletes the selected label(s).
- Moves the selected label(s) up or down in the list.
- Pins the selected label(s) (or all labels if there is no selection) to a Dashboard as either a table of values, bar chart or line graph. Note: Pinning labels with string data will display 0 for its value.
Automatically Reset labels - If this option is checked, then the object will automatically reset its labels back to their initial values on reset. When you apply the window, the values shown will be saved as the reset values. The reset values will also be automatically set when directly editing the labels on this tab while the model is reset.
labels can also be edited through the Quick Properties.
Tree View
If you click the Tree View button, you can view and edit the list of labels in a tree. The window then has a splitter bar in the middle to change the size of each panel. You can click the Tree View button again to hide to tree view panel.
Label Table View
If you click the Label Table button, you can view and edit label tables within the same view. The window then has a splitter bar in the middle to change the size of each panel. The Label Table panel will be an additional table view of the selected label. You can click the Label Table button again to hide to Label Table panel.
The commands used for editing tables can be used to edit label tables. The following example will set the value of the first cell in the label table "mylabeltable" to 8080 if current is a reference to this object.
settablenum(label(current,"mylabeltable"),1,1,8080);
Popup Menu
You can also edit labels by right clicking on a label. A popup menu will appear, giving you the options below. These options affect the label right-clicked on, not the entire selection.
Add Number Label - This option adds a number label to the object, the same as the Add Number Label button at the bottom.
Add Text Label - This option adds a text label to the object, the same as the Add Text Label button at the bottom.
Delete Label(s) - This option deletes the selected labels.
Duplicate Label(s) - This option duplicates the selected labels.
Create/Edit Label Table - This option lets you use a label as a two-dimensional table. It brings up a table edit window to edit the label as a table. To get and set values in this table during the model run, you can use the gettablenum() and settablenum() commands, passing a reference to the label as the first parameter using the label() command. For more information on these commands, refer to the command summary. Example: gettablenum(label(current, "curitemtype"), 4, 5);
Explore as Tree - This option lets you explore the selected label in a tree view.
