Element name

Example: refVisUserInfo

Type of element

Frame

Clipping

: Fixed size. Only that part of the referenced visualization that fits inside the frame is displayed.

Requirement: Scaling type property is Fixed.

Show frame

Shows the frame

• No frame: The displayed area of the frame does not have borders.

• Frame: The displayed area of the frame has borders.

• No frame with offset: The display area of the frame does not have a border and the display area of the referenced visualization is reduced inwards by one pixel as compared to the frame area. The effect of the intermediate space is that the refer­enced visualization and the neighboring elements do not touch each other.

Scaling type

The method with which the height and width of the referenced visualization are scaled.

• Isotropic: The visualization is scaled to the size of the element. The visualization retains its proportions with a fixed height/width ratio.

• Anisotropic: The visualization is scaled to the size of the element. The height and width are adapted to the element independently of each other.

• Fixed: the visualization is displayed in its original size without taking into account the size of the element.

• Fixed and scrollable: The visualization is displayed fixed in the element. If it is larger than the element, the element will be provided with scrollbars.

  Please note: assign variables to the proper­ties Scroll position variable horizontal or Scroll position variable vertical. You can then edit the data of the scrollbar position in the application.

Requirement: the property Scaling type is fixed and scrollable.

Scroll position variable horizontal

Variable (integer data type, also as array). Contains the position of the horizontal or vertical scrollbox. The array contains the position for every display variant. If the visualization runs on several display variants, then the position changes are decoupled from each other.

Example:

PLC_PRG.iScrollHor[CURRENTCLIENTID]

PLC_PRG.iScrollVer[CURRENTCLIENTID]

The variable is declared as an array in the example.

iScrollHor: ARRAY[0..20] OF INT;

iScrollVer: ARRAY[0..20] OF INT;

CURRENTCLIENTID indexes the current display variant.

Scroll position variable vertical

Deactivation of the background character

: The background is drawn. The non-animated element of the referenced visualization is drawn as a background bitmap in order to optimize the performance of the visualization.

Consequence: Elements can be displayed in an unexpected order at runtime. For example, an animated element can push itself behind the frame at runtime.

: Background character is deactivated in order to avoid the behavior described above.

References

Clicking Configure opens the Frame Configuration dialog. This is used to manage the referenced visualizations.

List of the currently referenced visualizations

Visualizations that have a button also have this displayed as a subnode. Each interface variable is listed with the currently assigned transfer parameters.

Example:

vis_FormA

• iDataToDisplay_1 : PLC_PRG.iVar1

• iDataToDisplay_2 : PLC_PRG.iVar2

Hint: You can change the assignment of the variables to an interface variable here and edit the value field. Or click the Configure button instead.

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

X

X-coordinate of the point of rotation

Y

Y-coordinate of the point of rotation

Color

Color of the frame

: Selection list with style colors appears

: Standard dialog Color opens for selecting a color.

Please note: the normal state is when the Boolean variable in the property Color variables ‣ Toggle color is not defined or its value is FALSE.

Alarm color

Color with which the element is filled during the alarm state.

Please note: Alarm state is when the value of the Boolean variable in the property Color variables ‣ Toggle color is FALSE.

Transparency

Integer number (value range from 255 to 0). Specifies the transparency of the associated color.

255: The color is opaque.

0: The color is fully transparent.

Please note: If the color is a style color and already contains a transparency value, then this property is write-protected.

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

• Solid

• Dashes

• Dots

• Dash Dot

• Dash Dot Dot

• not visible

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 .

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

• Default: The long text is truncated.

• Line break: The text is split into parts.

• Ellipsis: The visible text ends with "..." indi­cating that it is not complete.

Font

Example: Default

: The Font dialog box opens.

: Drop-down list with style fonts.

Font color

Example: Black

: The Color dialog box opens.

: Drop-down list with style colors.

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.

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

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

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.

Movement top-left

X

Variable (integer data type). It contains the number (in pixels) that the left edge is moved horizontally. Incrementing the value moves the element to the right.

Example: PLC_PRG.iDeltaX

Y

Variable (integer data type). It contains the number (in pixels) that the top edge is moved vertically. Incrementing the value moves the element to the down.

Example: PLC_PRG.iDeltaY

Movement bottom-right

X

Variable (integer data type). It contains the number (in pixels) that the right edge is moved horizontally. Incrementing the value moves the element to the right.

Example: PLC_PRG.iDeltaWidth

Y

Variable (integer data type). It contains the number (in pixels) that the bottom edge is moved vertically. Incrementing the value moves the element to the down.

Example: PLC_PRG.iDeltaHeight

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 .

Text list

Variable (string) or name of the text list as a fixed string in single straight quotation marks.

Example: 'Errorlist'

: Drop-down list with the dialogs available in the text lists.

Text index

Text list ID. This refers to the desired output text.

• As fixed string with the ID in single straight quotation marks.

  Example: '1'

• As a variable (STRING) for dynamically controlling the text output.

  Example: strTextID

  Sample assignment: PLC_PRG.strTextID := '1';

Tooltip index

Text list ID. This refers to the desired output text.

• As fixed string with the ID in single straight quotation marks.

  Example: '2'

• As a variable (STRING) for dynamically controlling the text output.

  Example: strToolTipID

  Sample assignment: PLC_PRG.strToolTipID := '2';

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.

• <pt>: Points (default)

  Example: PLC_PRG.iFontHeight <pt>

  Code: iFontHeight : INT := 12;

• <px> : Pixels

  Example: PLC_PRG.iFontHeight <px>

  Code: iFontHeight : INT := 19;

If you click in the value field, a drop-down list opens on the right for setting the unit.

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:

• 1: Italics

• 2: Bold

• 4: Underline

• 8: Strikethrough

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:

• 0: Top left

• 1: Horizontal center

• 2: Right

• 4: Vertical center

• 8: Bottom

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;

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 configura­tion of the element. Only then is the place­holder set. If you configure a variable in both Toggle and Tap, then the variable specified in Tap is used.

  Hint: Click the symbol to insert the place­holder <toggle/tap variable>. When you activate the Inputconfiguration, 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 assign­ment determines when the color changes.

Color

Color variable for the frame

• Variable (DWORD) for the color

  Example: PLC_PRG.dwColor

• Color literal

  Example of gray and opaque: 16#FF888888

Requirement: Show frame property is activated.

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 for the frame in alarm state

• Variable (DWORD) for the alarm color

  Example: PLC_PRG.dwAlarmColor

• Color literal

  Example of red and opaque: 16#FFFF0000

Please note that the alarm state is in effect if the expression in the Colorvariables ‣ Toggle color property has the value TRUE.

Line width

Variable (integer data type). Contains the line weight (in pixels).

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

Variable (DWORD). Controls the line style.

Coding:

• 0: Solid line

• 1: Dashed line

• 2: Dotted line

• 3: Line type "Dash Dot"

• 3: Line type "Dash Dot Dot"

• 8: Invisible: The line is not drawn.

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.

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.

Variable

Variable (integer data type). Contains the index of the active visualization.

Example: PLC_PRG.uiActiveVisuID.

Tip: The Frame Configuration dialog includes a list of selected visualizations. The visualizations are ordered automatically in numeric order in the list.

Note: This variant of switching usually affects all connected display variants.

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: PLC_PRG.i_x := 0;

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

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

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

: The value toggles regardless of where the mouse pointer is when the mouse button is released. The mouse is then 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)

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

Shift

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