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 'Legend'
dl-pagination__prev-inactivedl-pagination__prev-activedl-pagination__next-inactivedl-pagination__next-active
Visualization Element 'Legend'dl-permalink__symbolPermalink

Symbol:

_visu_icon_legend

Category: “Special Controls”

The element is used as a legend for another element (for example, a trend). The legend is assigned in the properties of the other element.

Element properties

“Element name”

Example: ‎LegendOfTrendA‎

Optional

Hint: Assign individual names for elements so that they are found faster in the element list.

“Type of element”

“Legend”

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

“Orientation”

Orientation of the element. The value is configured in the assigned element.

  • “Horizontal”

  • “Vertical”

“Attached element instance”

Example: ‎Element_A‎

“Show frame”

_cds_icon_option_activated: The element is displayed with frames.

“Number format”

The format of the value in printf syntax (example: %d, %5.2f)

Element Property 'Layout'

Defines how many variables can be displayed at a maximum and is calculated from the row and column number.

“Max. number of rows”

Example: ‎3‎

“Max. number of columns”

Example: ‎2‎

Element Property 'Text properties'

The property affects the text configured in the associated element.

“Text format”

“Default”: The text will be cut and displayed in only the part that fits into the visualization element.

“Linebreak”: The text will be wrapped in rows.

“Ellipsis”: The text is cut and ellipsis ‎...‎ are added to indicate that something is missing.

“Font”

Font of the text. The entries of the selection list are defined in the visualization style.

“Font color”

Text color, for example ‎Grey‎. The entries of the selection list are defined in the visualization style.

“Transparency”

Transparency value (255 to 0), which defines the transparency of the corresponding color.

Example: 255: The color is opaque. 0: The color is fully transparent.

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

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