Visualization Element: Potentiometer

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.

X

X-coordinate of the point of rotation

Y

Y-coordinate of the point of rotation

Movement

X

Increasing this value at runtime moves the element to the right.

Y

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.

Scaling

Variable (integer data type) to trigger a centric stretching

Example: PLC_PRG.iScaling

The reference point is the Center property.

The value 1 shrinks the element by a factor of 0.001. The value 1000 returns the element to its original size.

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.

Animation duration

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

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

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

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.

Toggle on up if captured

: 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

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.

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

Image color

List box containing background colors

Own image

Arrow type

List box with different arrow types

Color

Arrow start

Angle (in degrees) between the left edge of the element and the horizontal axis

Arrow end

Angle (in degrees) between the right edge of the element and the horizontal axis

Sub scale position

Scale type

Scale start

Least value of the scale and the lower limit of the value range for the element

Example: 0

Variable

Variable (integer data type) for the start value of the scale

Example: PLC_PRG.iScaleStart

Scale end

Greatest value of the scale and the upper limit of the value range for the element

Example: 100

Variable

Variable (integer data type) for the scale end

Example: PLC_PRG.iScaleEnd

Main scale

Distance between two values on the main scale

Example: 10

Variable

Variable (integer data type) Contains the distance.

Example: PLC_PRG.iMainScale

Sub scale

Distance between two values on the fine scale

Example: 2

Variable

Variable (integer data type) for the spacing between two values on the fine scale

Example: PLC_PRG.iSubScale

Scale line width

In pixels

Example: 3

Scale color

Color of the tick marks

Scale in 3D

: Tick marks are displayed with soft 3D shadowing.

Show scale

: Scale is displayed

Frame inside

: Frame at the inner edge of the scale is displayed

Frame outside

: Frame at the outer end of the scale is displayed

Label

Unit

Text which is displayed in the element

Example: Display of unit in m/s

Font

Font for labels (example: scale numbering).

Selection from the list box or by clicking the button.

Scale format (C syntax)

Values scaled in printf syntax

Examples: %d, %5.2f

Max. text width of labels

Optional value that defines the maximum width of the scale label

The value is set automatically.

Text height of labels

Optional value that defines the maximum height of the scale label

The value is set automatically.

Font color

Selection from the list box or by clicking the button

Usage of

Preset style values: Values from the current style

User-defined settings: The subnode Positioning appears.

Positioning

Requirement: User-defined settings is selected as Usage of.

The displayed positioning settings depend on the type of needle instrument and potentiometer, and partially on whether a custom background image is selected.

The following settings are used for achieving the exact position relative to the background image.

Needle movement

Length of the needle (in pixels)

Scale movement

Requirement: A customer image is selected as Background.

Distance from the tick marks to the center (in pixels)

Scale length

Requirement: A customer image is selected as Background.

Length of the tick marks (in pixels)

Label offset:

Distance from the labels to the tick marks (in pixels)

Unit offset:

Distance of the unit text Label → Unit from the upper scale edge (in pixels)

Origin offset

Requirement: For the elements Meter 180° and Meter 90°, this property is displayed only if a custom image is selected as Background.

Offset of the element (in pixels)

Color areas

Durable color areas

: Only the color area is visible that includes the actual value.

: All color areas are visible, regardless of the actual value.

Use colors for scale

: The color area is removed from the list and the list is refreshed.

Color areas

Create new

Adds a new color range in the Elements view

Delete

Removes from the list the color range and refreshes the list

Begin of area

Start value of the color area

Example: 20

Variable

Variable (integer data type) for the start of the area

Example: PLC_PRG.iColorAreaStart0

Declaration:

PROGRAM PLC_PRG
VAR
    iColorAreaStart0 : INT := 80;
END_VAR

End of area

End value of the color area

Example: 120

Variable

Variable (integer data type) for the end of the area

Example: PLC_PRG.iColorAreaEnd0

Declaration:

PROGRAM PLC_PRG
VAR
    iColorAreaEnd0: INT := 100;
END_VAR

Color

Color that is used for displaying the area

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.

Access Rights button

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