Tag: Basic
The element draws a single line.
Element name |
Optional. Example: Separator_Header Hint: Assign individual names for elements so that they are found faster in the element list. |
Type of element |
Line |
The following properties define the position and length 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.
Dots |
[0]: Coordinates of the starting point [1]: Coordinate of the end point
You can also change the values by dragging the box symbols ( |
Angle |
Static angle of rotation (in degrees). Example: 35 The element is displayed rotated in the editor. The point of rotation is the center of the element. A positive value rotates clockwise.
Tip: You can change the value in the editor by focusing the element to the handle. When the cursor is displayed as a rotating arrow Example:
Note: If a dynamic angle of rotation is also configured in the property Absolute movement ‣ Internal rotation , then the static and dynamic angles of rotation are added in runtime mode. The static angle of rotation acts as an offset. |
See also
The properties contain fixed values for the coordinates of the point of rotation. This point of rotation is shown as the 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 |
Note
You can also change the values by dragging the symbols () to other positions in the editor.
The properties contain fixed values for setting colors.
Color |
Color of the line in normal state. Please note that the normal state is in effect if the expression in the Color variables ‣ Toggle color property is not defined or it has the value FALSE. |
Alarm color |
Color of the line in alarm state. Please note that the alarm state is in effect if the expression in the Color variables ‣ Toggle color property has the value TRUE. |
Transparency |
Value (0 to 255) for defining the transparency of the selected color. Example 255: The color is opaque. 0: The color is completely transparent. |
See also
The properties contain fixed values for setting the look of the element.
Line width |
Value in pixels Example: 2 Note: The values 0 and 1 both result in a line weight of one pixel. If no line should be displayed, then the Line style property must be set to the option Invisible. |
Line style |
Type of line representation
|
Note
You can assign variables in the Appearance variables property for controlling the appearance dynamically. The fixed values are defined here.
See also
The properties contains character strings for labeling the element. The character string can also contain a placeholder with a format definition. In runtime mode, the placeholder is replaced by the current value in the specified format.
CODESYS accepts the specified texts automatically into the GlobalTextList text list. Therefore, these texts can be localized.
Text |
Character string (without single straight quotation marks) for the labeling the element. Add a line break by pressing the keyboard shortcut Ctrl + Enter. Example: Accesses: %i The variable that contains the current value for the placeholder is specified in the property Text variable ‣ Text . |
Tooltip |
Character string (without single straight quotation marks) that is displayed as the tooltip of an element. Example: Number of valid accesses. The variable that contains the current value for the placeholder is specified in the property Text variable ‣ Tooltip . |
See also
Element property 'Text properties'
The properties contain fixed values for the text properties.
Horizontal alignment |
Horizontal alignment of the text within the element. |
Vertical alignment |
Vertical alignment of the text within the element. |
Text format |
Definition for displaying texts that are too long
|
Font |
Example: Default
|
Font color |
Example: Black
|
Transparency |
Whole number (value range from 0 to 255). This determines the transparency of the respective color. Example: 255: The color is opaque. 0: The color is completely transparent. Please note: If the color is a style color and already has a transparency value, then this property is write-protected. |
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 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. |
|
Scaling |
Variable (integer data type). Causes 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). 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 Note: If a static angle of rotation is specified in the property Position ‣ Angle , then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed. |
|
Use REAL values |
Note: Only available if the device supports the use of REAL coordinates.
The option allows for the individual fine-tuning of drawing the element, for example for the visualization of a smoother rotation. Hint: If a horizontal or vertical line is drawn blurry on a specific visualization platform, then this can be corrected by an offset of 0.5px in the direction of the line thickness. |
Note
You can link the variables to a unit conversion.
Note
The properties X, Y, Rotation, and Interior rotation are supported by the "Client Animation" functionality.
See also
Element property 'Relative movement'
The properties contains variables for moving the element. The reference point is the position of the element (Position property). The shape of the element can change.
Movement point[0]
|
Variable (numeric data type). It contains the number (in pixels) that the starting point of the line is moved. Incrementing the X value moves the element to the right. Incrementing the Y value moves the element to the down. |
Movement point[1]
|
Variable (numeric data type). It contains the number (in pixels) that the end point of the line is moved. Incrementing the X value moves the element to the right. Incrementing the Y value moves the element to the down. |
See also
Element property 'Text variables'
These properties are variables with contents that replace a format definition.
Text variable |
Variable (data type compliant with the format definition). It contains what is printed instead of the format definition. Example: PLC_PRG.iAccesses Note: The format definition is part of the text in the property Texts ‣ Text . Note: If you specify a variable of type enumeration with text list support, then the name of the enumeration data type is added automatically in angle brackets after the variable name. Example: PLC_PRG.enVar <enumeration name>. Then the symbolic value of the enumeration component is printed instead of the numeric value when text is printed. Refer to the help page for the enumerations. |
Tooltip variable |
Variable (data type compliant with the format definition). It contains what is printed instead of the format definition. Example: PLC_PRG.iAccessesInTooltip Note: The format definition is part of the text in the property Texts ‣ Tooltip . |
See also
Element property 'Dynamic texts'
Dynamic texts are variably indexed texts of a text list. At runtime, the text is displayed that is currently indexed in the variable.
Text list |
Variable (string) or name of the text list as a fixed string in single straight quotation marks. Example: 'Errorlist'
|
Text index |
Text list ID. This refers to the desired output text.
|
Tooltip index |
Text list ID. This refers to the desired output text.
|
See also
Element property 'Font variables'
The variables allow for dynamic control of the text display.
Font name |
Variable (STRING). Includes the font of the text. Example: PLC_PRG.stFontVar := 'Arial'; The selection of fonts corresponds to the default Font dialog. |
Size |
Variable (numeric data type). Contains the font size (in pixels or points). The applied unit is specified in brackets after the variable name.
Hint: The font size is specified in points (example: Arial 12). Use points when the variable font size should match a font, for example if a font is set in the property Text property ‣ Font . |
Flags |
Variable (DWORD). Contains the flags for displaying fonts. Flags:
Note: You can combine the font displays by adding the coding of the flags. For example, a bold and underlined text: PLC_PRG.dwFontType := 6; |
Character set |
Variable (DWORD). Contains a character set number for the font. The selection of character set numbers corresponds to the Script setting of the standard Font dialog. |
Color |
Variable (DWORD). Includes the color of the text. Example: PLC_PRG.dwColorFont:= 16#FF000000; |
Flags for text alignment |
Variable (integer data type). Contains the coding for text alignment. Example: PLC_PRG.dwTextAlignment. Coding:
Note: You can combine the text alignments by adding the coding of the flags. For example, a vertical and horizontal centered text: PLC_PRG.dwFontType := 5; |
Note
Fixed values for displaying texts are set in Text properties.
See also
Element property 'Colorvariables'
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:
Assigning the property:
|
Color |
Please note that the normal state is in effect if the expression in the Colorvariables ‣ Toggle color property is not defined or it has the value FALSE. |
Alarm color |
Color variable in the alarm state
Please note that the alarm state is in effect if the expression in the Colorvariables ‣ Toggle color property has the value TRUE. |
Note
The transparency part of the color value is evaluated only if the Activate semi-transparent drawing option of the visualization manager is selected.
Note
Select the Advanced option in the toolbar of the properties view. Then all element properties are visible.
See also
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. |
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. |
Note
The Invisible property is supported by the "Client Animation" functionality.
See also
Element property 'Line width variable'
Dynamic definition of the weight of a line element using a variable.
Integer value |
Variable (integer data type). Defines the line weight of the element (in pixels). This overwrites the fixed value that is defined in Appearance ‣ Line weight . Note: The value 0 codes the same as 1 and sets the line weight to one pixel. |
Element property 'Line style variable'
Integer value |
Variable (integer data type). Defines the appearance of the line at runtime.
|
These properties are available only when you select the Preview: Support client animations and overlay of native elements option in the Visualization Manager.
You can animate a movement, a rotation, and the visibility of a visualization element.
Animation time |
Time that the element executes an animation (in milliseconds) Example: 500 |
Move to the foreground |
Property value (BOOL) TRUE: At runtime, the element is displayed in the foreground. FALSE: At runtime, the element is displayed in the layer where it was inserted in the visualization editor. |
See also
Element property '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.
The Configure button opens the Input configuration dialog box for creating or modifying a user input. Configured user inputs are briefly listed below the events. They each include the action that is triggered and the setting in short form.
Example: Execute ST code: |
|
OnDialogClosed |
Input event: The user closes the dialog box. |
OnMouseClick |
Input event: The user clicks the mouse button completely. 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 event: The user releases the mouse button over the element area. |
Tap |
When a mouse click event occurs, the variable defined in Variable is described in the application. The coding depends on the options Tap FALSE and Tap on enter if captured. |
Variable |
Variable (BOOL) that is set on mouse click. Example: PLC_PRG.bIsTapped TRUE: A mouse click event exists. It lasts while the user presses the mouse button over the element. It ends when the button is released. FALSE: A mouse click event does not exist. Requirement: The Tap FALSE option is not activated. |
Tap FALSE |
TRUE: A mouse click event does not exist. FALSE: While the mouse click event exists. |
Tap on enter if captured |
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. |
Shift |
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). Its value toggled when the mouse click event is ended. 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 |
|
Keyboard shortcuts |
Keyboard shortcut on the element for triggering specific input actions. When the keyboard shortcut event occurs, the input actions in the Event(s) 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 Note: The following properties appear when a key is selected. |
Event(s) |
|
Shift |
Example: Shift+T. |
Control |
Example: Ctrl+T. |
Alt |
Example: Alt+T. |
Note
All keyboard shortcuts and their actions that are configured in the visualization are listed in the Keyboard configuration tab.
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:
|
See also