Visualization Element: Spin Box

Symbol:

Category: Common Controls

The element increments or decrements the value of a variable in defined intervals.

Element properties

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Element name	Example: `Speed controller conveyor belt` Tip Assign individual names for elements so that they are found faster in the element list.
Element Type	Spin Box

Position

The position defines the location and size of the element in the visualization window. This is based on the Cartesian coordinate system. The origin is located in the upper left corner of the window. The positive horizontal X-axis runs to the right. The positive vertical Y-axis runs downwards.

X	The X-coordinate (in pixels) of the upper left corner of the element Example: `10`
Y	The Y-coordinate (in pixels) of the upper left corner of the element Example: `10`
Width	Specified in pixels Example: `150`
Height	Specified in pixels Example: `30`

Tip

You can change the values by dragging the box symbols to other positions in the editor.

Center

	The properties contain fixed values for the coordinates of the point of rotation. The rotation point is displayed in the editor as the symbol and is used as the center for rotation and scaling. Tip You can also change the values by dragging the symbol to another position in the editor.
X	X-coordinate of the point of rotation
Y	Y-coordinate of the point of rotation

Variable

Variable (numeric data type)

Example: PLC_PRG.iTemp

Number format

Format of the value in printf syntax

Example: %d, %5.2f

Interval

Interval used for modification of the value

Value range

Minimum value	. Lower limit of the output value As a fixed value Variable (`INT`)
Maximum value	. Upper limit of the output value As a fixed value Variable (`INT`)

Text properties

The properties get fixed values for the text properties and act on the texts configured in Texts → Text or Texts → Tooltip.

Usage of

Default style values, then the values of the visualization style are accepted
Individual settings
The Individual text properties property group is shown. The values can be customized here.

Individual text properties
Horizontal alignment	Horizontal alignment of the text within the element
Vertical alignment	Vertical alignment of the text within the element
Font	Example: Default : The Font dialog opens. : List box with style fonts
Font color	Example: Black : The Color dialog opens. : List box with style colors
Transparency	Integer (value range from `0` to `255`) The transparent value determines the transparency of the respective color. `255`: The color is opaque. `0`: The color is completely transparent. Note If the color is a style color and already has a transparency value, then this property is write-protected.

Color variables

The Element property is used as an interface for project variables to dynamically control colors at runtime.

Toggle color

The property controls the toggled color at runtime.

. Value assignment:

FALSE: The element is displayed with the color specified in the Color property.
TRUE: The element is displayed with the color specified in the Alarm color property.

. Assigning the property:

Placeholder for the user input variable
- <toggle/tap variable>
- <NOT toggle/tap variable>
The color change is not controlled by its own variable, but by a user input variable.
Note: Specify a variable for the mouse events Tap or Toggle in the input configuration of the element. Only then is the placeholder set. If you configure a variable in both Toggle and Tap, then the variable specified in Tap is used.
Click the symbol to insert the <toggle/tap variable> placeholder. When you activate the Input configuration, Tap FALSE property, then the <NOT toggle/tap variable> placeholder is displayed.
Instance path of a project variable (BOOL)
Example: PLC_PRG.xColorIsToggeled
Note: In the code, declare and implement the variable specified here. Its value assignment determines when the color changes.

Tip

The transparency part of the color value is evaluated only if the Activate semi-transparent drawing option of the visualization manager is selected.

Tip

In the toolbar of the Properties, select the Advanced option. Then all element properties are visible.

State variables

The variables control the element behavior dynamically.

Invisible

Variable (BOOL) for toggling the visibility of the element

TRUE: The element is not visible at runtime.

Example: bIsVisible with VAR bIsVisible : BOOL := FALSE; END_VAR

Deactivate inputs

Variable (BOOL) for toggling the operability of the element

TRUE: User inputs do not have any effect in runtime more. The element is shown as deactivated.

Tip

The Invisible property is supported by the "Client Animation" functionality.

Absolute movement

The properties can be assigned to IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. At runtime, the entire element is moved.

Movement
X	Variable (numeric data type) for the X-position (in pixels) Example: `PLC_PRG.iPos_X` Container variable: `Container.Width` For more information, see the following: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element to the right.
Y	Variable (numeric data type) for the Y-position (in pixels) Example: `PLC_PRG.iPos_Y` Container variable: `Container.Height` For more information, see the following: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element downwards.
Rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle1` The midpoint of the element rotates at the Center point. This rotation point is shown as the symbol. At runtime, the alignment of the element remains the same with respect to the coordinate system of the visualization. Increasing the value rotates the element to the right.
Interior rotation	Variable (numeric data type) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle2` At runtime, the element rotates about the point of rotation specified in Center according to the value of the variable. In addition, the alignment of the element rotates according to the coordinate system of the visualization. Increasing the value in the code rotates clockwise. The rotation point is shown as the symbol. Note If a static angle of rotation is specified in the Position → Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed.

Tip

You can combine the variables to a Unit conversion.

Tip

The X, Y, Rotation, and Interior rotation properties are supported by the "Client Animation" functionality.

Animation

Tip

These properties are available only when you have selected the Support client animations and overlay of native elements option in the Visualization Manager.

Animation duration

Variable for the duration (in milliseconds) in which the element runs an animation

Variable (integer value)
Example: Menu.tContent with VAR tContent : INT := 500; END_VAR
Integer literal
Example: 500

. Animatable properties

Absolute movement, Movement, X, Y
Absolute movement, Rotation
Absolute movement, Interior rotation
Absolute movement, Exterior rotation

The animated movement is executed when at least one value of an animatable property has changed. The movement then executed is not jerky, but is smooth within the specified animation duration. The visualization element travels to the specified position while rotating dynamically. The transitions are smooth.

Move to foreground

Variable (BOOL) for setting the element in the foreground

TRUE: At runtime, the visualization element is displayed in the foreground.

FALSE: At runtime, the visualization element is displayed in the layer where it was inserted in the visualization editor.

Example: bIsInForeground with VAR bIsInForeground : BOOL := FALSE; END_VAR

Input Configuration

The properties contain the configurations for the user input when using the mouse or keyboard. A user input defines an event and one or more actions that are executed when an event occurs.

Tip The Configure button opens the Input Configuration dialog. There you can create or edit user inputs. Configured user inputs are listed below the events. They each include the action that is triggered and the setting in short form. Example: Execute ST Code: `PLC_PRG.i_x := 0;`
OnDialogClosed	Input event: The user closes the dialog.
OnMouseClick	Input event: The user clicks the mouse button completely in the element area. The mouse button is clicked and released.
OnMouseDown	Input event: The user clicks down on the mouse button.
OnMouseEnter	Input event: The user drags the mouse pointer to the element.
OnMouseLeave	Input event: The user drags the mouse pointer away from the element.
OnMouseMove	Input event: The user moves the mouse pointer over the element area.
OnMouseUp	. Input events: The user releases the mouse button within the element area. It is irrelevant whether the user has previously pressed the mouse button inside or outside the element area. The user presses the mouse button within the element area, leaves the element area, and then releases the mouse button. Note This CODESYS-specific triggering behavior guarantees that actions for key elements are completed. A key element starts an action for OnMouseDown and ends the action for OnMouseUp. Example: A visualization user presses the mouse button within the element area of the key element and then moves the cursor position so that it is located outside of the element area. The action is ended anyway because OnMouseUp is triggered.
OnValueChanged	Event which triggers follow-up actions due to a change in value Which follow-up actions are triggered is configured in the Input Configuration dialog. The defined follow-up actions and the corresponding configuration are displayed below the element property. The OnValueChanged event can be disabled by the VISU_NO_VALUECHANGED compiler define in the properties dialog of the application.

Tap	When a mouse click event occurs, the variable defined in Variable is described in the application. The coding depends on the Tap FALSE and Tap on enter if captured options.
Variable	Requirement: The Tap FALSE option is not activated. Variable (`BOOL`) for the mouse click event `TRUE`: A mouse click event exists. It lasts as long as the user presses the mouse button over the element. It ends when the button is released. `FALSE`: A mouse click event does not exist. Example: `PLC_PRG.bIsTapped`
Tap FALSE	: The mouse click event leads to a complementary value in Variable. `TRUE`: A mouse click event does not exist. `FALSE`: While the mouse click event exists.
Tap on enter if captured	: During user input, it is also taken into consideration whether the mouse pointer is dragged within the element area or not while the mouse button is pressed. `TRUE`: While the mouse click event exists and the mouse pointer is moved over the element area. `FALSE`: A mouse click event does not exist. Or the user moves the mouse pointer outside of the element area while the mouse button is pressed. The value is `TRUE` again as soon as the user moves the pointer back to the element area. The mouse is then captured.

Switch over

With the onset of a mouse click event, the variable is set; when the mouse click event is completed, the variable is reset.

Variable

Variable (BOOL) for toggling at the end of the mouse click event

This is when the user releases the mouse button while the mouse pointer is over the element area. If the user releases the mouse button while the mouse pointer is outside of the element area, then the mouse click event is not ended and the value is not toggled.

Tip

The user can cancel a started toggle input by dragging the mouse pointer out of the element area.

Toggle on up if captured

standard icon : The value toggles regardless of where the mouse pointer is when the mouse button is released. The mouse is then captured.

Hotkey	Shortcut on the element for triggering specific input actions When the hotkey event occurs, the input actions in the Events property are triggered. In this way, it is not the input action itself that leads to this input action, but the mouse input action.
Key	Key pressed for input action. Example: T The following properties appear when a key is selected.
Events	None Mouse down: Pressing the key triggers the input actions that are configured in the OnMouseDown property. Mouse up: Releasing the key triggers the input actions that are configured in the OnMouseUp property. Mouse down/up: Pressing and releasing the key triggers the input actions that are configured in the OnMouseDown property and the OnMouseUp property.
Switch over	: Combination with the "Shift" key Example: Shift+T.
Control	: Combination with the "Ctrl" key Example: Ctrl+T.
Alt	: Combination with the "Alt" key Example: Alt+T.

Tip

All keyboard shortcuts and their actions that are configured in the visualization are listed on the Keyboard Configuration tab.

Permissions

Note

Available only when a user management is set up for visualization.

Access Rights button

Opens the Access Rights dialog. There you can edit the access privileges for the element.

. Status messages:

Not set. Full rights.: Access rights for all user groups : operable
Rights are set: Limited rights: Access is restricted for at least one group.