dl-breadcrumbs__homedl-breadcrumb-item__separatorConfiguration and programmingdl-breadcrumb-item__separatorProgramming with CODESYSdl-breadcrumb-item__separator...dl-breadcrumb-item__separatorCODESYS Visualizationdl-breadcrumb-item__separatorReference, Programmingdl-breadcrumb-item__separatorVisualization Elementsdl-breadcrumb-item__separatorVisualization Element 'Potentiometer'
dl-pagination__prev-inactivedl-pagination__prev-activedl-pagination__next-inactivedl-pagination__next-active
Visualization Element 'Potentiometer'dl-permalink__symbolPermalink

Symbol:

_visu_img_potentiomenter

Category: “Measurement Controls”

The element displays the value of a variable as a setting on the potentiometer. A visualization user can modify the value by dragging the pointer to another position.

Element properties

“Element name”

Example: ‎GenElemInst_1‎

“Type of element”

“Potentiometer”

“Variable”

Variable (numeric data type). Contains the position of the pointer for the potentiometer.

A visualization user can modify the value by dragging the pointer to another position.

Element property 'Center'

The properties contain fixed values for the coordinates of the point of rotation. This point of rotation is shown as the _visu_icon_center_point.png symbol. The point is used as the center for rotating and scaling.

“X”

X-coordinate of the point of rotation

“Y”

Y-coordinate of the point of rotation

You can also change the values by dragging the symbols (_visu_icon_center_point.png) to other positions in the editor.

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”

Defines 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”

Moves the visualization element to the foreground

Variable (‎BOOL‎)

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

‎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.

Element property 'Position'

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

“X”

X coordinate of the upper left corner of the element

Specified in pixels.

Example: ‎10‎.

“Y”

Y coordinate of the upper left corner of the element

Specified in pixels.

Example: ‎10‎.

“Width”

Specified in pixels.

Example: ‎150‎

“Height”

Specified in pixels.

Example: ‎30‎

You can also change the values by dragging the box symbols (_visu_icon_position_element) to other positions in the editor.

Element property 'Background'

“Image color”

List box containing background colors

“Own image”

  • “Image”: ID of the background image.

    You select the background image from an image pool by clicking button_threedots.png.

    Info: If you specify the value “<default>” or select the image from the “Default” category in the Input Assistant, then the original element background image is used.

  • “Transparency color”: Selection from list box or Input Assistant.

Element property 'Arrow'

“Hand style”

Drop-down list with different arrow types

“Color”

  • _cds_icon_three_dots: The “Color” dialog box opens.

  • _cds_icon_arrow_down: Drop-down list with color names

“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

Element property 'Scale'

“Sub scale position”

  • “Outside”: The subscale is displayed on the outer scale ring. (“Frame outside”)

  • “Inside”: The subscale is displayed on the inner scale ring. (“Frame inside”)

“Scale type”

Type of scale

  • “Lines”

  • “Dots”

  • “Squares”

“Scale start”

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

Example: ‎0‎

_visu_icon_variable: The “Variable” property is displayed in the line below this.

“Variable”

Variable (integer data type). Contains the scale start

Example: ‎PLC_PRG.iScaleStart‎

Declaration:

PROGRAM PLC_PRG
VAR
		iScaleStart : INT := 0;
END_VAR

“Scale end”

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

Example: ‎100‎

_visu_icon_variable: The “Variable” property is shown below this.

“Variable”

Variable (integer data type). Contains the scale end

Example: ‎PLC_PRG.iScaleEnd‎

Declaration:

PROGRAM PLC_PRG
VAR
		iScaleEnd : INT := 120;
END_VAR

“Main scale”

Distance between two values on the main scale

Example: ‎10‎

_visu_icon_variable: The “Variable” property is shown below.

“Variable”

Variable (integer data type) Contains the distance between two values on the main scale

Example: ‎PLC_PRG.iMainScale‎

Declaration:

PROGRAM PLC_PRG
VAR
		iMainScale : INT := 20;
END_VAR

“Sub scale”

Distance between two values on the fine scale

You can hide the fine scale by setting the value to ‎0‎.

Example: ‎2‎

_visu_icon_variable: The “Variable” property is shown below this.

“Variable”

Variable (integer data type) Contains the distance between two values on the fine scale

Example: ‎PLC_PRG.iSubScale‎

Declaration:

PROGRAM PLC_PRG
VAR
		iSubScale : INT := 5;
END_VAR

“Scale line width”

Specified in pixels

Example: ‎3‎

“Scale color”

Color of scale lines

  • _cds_icon_three_dots: The “Color” dialog opens.

  • _cds_icon_arrow_down: A list box with style colors opens.

“Scale in 3D”

_cds_icon_option_activated: Scale lines are displayed with soft 3D shadowing.

Note: This property is not displayed in “FlatStyle”.

“Show scale”

_cds_icon_option_activated: The scale is displayed.

“Frame inside”

_cds_icon_option_activated: A frame is drawn at the inner end of the scale.

“Frame outside”

_cds_icon_option_activated: A frame is drawn at the outer end of the scale.

Element property 'Label'

“Label”

Selection list

  • “Outside”: Scale values are placed outside of the scale.

  • “Inside”: Scale values are placed inside of the scale.

“Unit”

Text that is displayed in the element.

Example: Units displayed in m/s.

“Font”

Font for labels (example: scale numbering).

Selection from the drop-down list or by clicking the button. button_threedots.png

“ Scale format (C Syntax)”

Values scaled in "printf" syntax

Examples: ‎%d, %5.2f‎

“Max. text width of labels”

(optional) Value that redefines the maximum width of the scale label. The correct value is normally set automatically.

Note: Change this value only if the automatic adjustment does not yield the expected result.

“Text height of labels”

(optional) Value that redefines the maximum height of the scale label. The correct value is normally set automatically.

Note: Change this value only if the automatic adjustment does not yield the expected result.

“Font color”

Selection from the drop-down list or by clicking the button_threedots.png button.

Element property 'Positioning'

“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”

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

Requirement: A customer image is selected as “Background”.

“Scale length”

Length of the tick marks (in pixels)

Requirement: A customer image is selected as “Background”.

“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”

Offset of the element (in pixels)

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

Element property 'Colors'

“Color areas”

“Durable color areas”

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

_cds_icon_option_activated: Only the color area is visible that includes the current value.

“Use colors for scale”

_cds_icon_option_activated: Colors in the color area are used only for the scale and frame.

“Color areas”

“Create new”

A new color area is added to the “Elements” view.

“ Delete”

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

“Begin of area”

Start value of the color area

Example: ‎20‎

_visu_icon_variable: The property “Variable” is shown below.

“Variable”

Variable (integer data type). Contains the start value.

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‎

_visu_icon_variable: The property “Variable” is shown below.

“Variable”

Variable (integer data type). Contains the end value.

Example: ‎iColorAreaEnd0‎

Declaration:

PROGRAM PLC_PRG
VAR
		iColorAreaEnd0 : INT := 100;
END_VAR

“Color”

Color that is used for displaying the area.

Element property 'State variables'

The variables control the element behavior dynamically.

“Invisible”

Variable (‎BOOL‎). Toggles 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‎). Toggles the operability of the element.

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

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

Element property 'Absolute movement'

The properties contain IEC variables for controlling the position of the element dynamically. The reference point is the upper left corner of the element. In runtime mode, the entire element is moved.

“Movement”

“X”

Variable (numeric data type). Defines the X position (in pixels).

Example: ‎PLC_PRG.iPos_X‎.

Increasing this value in runtime mode moves the element to the right.

“Y”

Variable (numeric data type). Defines the Y position (in pixels).

Example: ‎PLC_PRG.iPos_Y‎.

Increasing this value in runtime mode moves the element downwards.

“Rotation”

Variable (numeric data type). Defines 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 _visu_icon_center_point.png symbol.

In runtime mode, 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.

 _visu_img_prp_rotation

“Interior rotation”

Variable (numeric data type). Defines the angle of rotation (in degrees).

Example: ‎PLC_PRG.iAngle2‎.

In runtime mode, 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 _visu_icon_center_point.png 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.

 _visu_img_prp_inner_rotation

You can link the variables to a unit conversion.

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

See also

Element property 'Access rights'

Requirement: User management is set up for the visualization.

“Access rights”

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.