Visualization Element 'Histogram'

Symbol:

Tag: Measurement Controls

The element displays the data of a one-dimensional array as a histogram. You can define specific colors for certain value ranges.

See also

Element properties

Element name

Example: GenElemInst_35

Type of element

Histogram

Data array

One-dimensional array with data displayed in this histogram.

Example: PLC_PRG.arr1

Element property 'Subrange of array'

Use subrange

: Only part of the array is displayed in the histogram.

Start index

First array index with a displayed value.

Requirement: Use subrange is activated.

End index

Last array index with a displayed value.

Requirement: Use subrange is activated.

Display type

  • Bars: Data is displayed as bars.

  • Lines: Data is displayed as lines.

  • Curve: Interpolation of data into a curve.

Line width

Specified in pixels

Requirement: Curve is selected as the Display type.

Show horizontal lines

: Horizontal lines are drawn on the main scale.

Note: Not all visualization styles have this property. This element property is not available for visualization styles that have striped backgrounds (example: Flat style).

Relative bar width

Integer value between 1 and 100

  • 1: The bars are drawn as lines.

  • 100: The entire width of the histogram is filled with the bars.

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

Note

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

See also

Element property 'Center'

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.

Element property 'Scale'

Scale start

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

Example: 0

: The property Variable is shown below.

Variable

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

Example: PLC_PRG.iScaleStart

Scale end

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

Example: 100

: The property Variable is shown below.

Variable

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

Example: PLC_PRG.iScaleEnd

Main scale

Distance between 2 values on the rough scale.

Example: 10

: The property Variable is shown below.

Variable

Variable (integer data type). Contains the distance.

Example: PLC_PRG.iMainScale

Subscale

Distance between 2 values on the fine scale.

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

Example: 2

: The property Variable is shown below.

Variable

Variable (integer data type). Contains the spacing.

Example: PLC_PRG.iSubScale

Scale color

Color of scale lines

  • :

    The Color dialog box opens.

  • : A drop-down list with color names opens.

Base line

Value of the main scale where the horizontal base line of the Histogram is located.

The drawing of the bar starts at the base line.

Example

A valid declaration is required for the variables used as an example in the table above. 

PROGRAM PLC_PRG
VAR
        iScaleStart : INT := 0;
        iScaleEnd : INT := 120;
        iMainScale : INT := 20;
        iSubScale : INT := 5;
END_VAR

Element property 'Label'

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.

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.

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

Text height of labels

Optional value that defines the maximum height of the scale label.

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.

Element property 'Colors'

Graph color

Color of the bar in normal state.

Note: The normal state is in effect when the current value of the array component does not fulfill the alarm condition.

Alarm value

Threshold for the alarm

Alarm condition

If the current value of the array component fulfills the alarm condition, then the alarm condition is set.

  • Less: The current value is less than the Alarm value

  • More: The current value is greater than the Alarm value

Alarm color

Color of the bar in alarm state.

Use color areas

: The color areas defined in this element are used.

Color areas

Create new

A new color area is added.

Delete

The color area is removed from the list.

Begin of area

The start value on the Scale of the Histogram where the color area begins.

End of area

The end value on the Scale of the Histogram where the color area ends.

Color

Color that is used for displaying the area.

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

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 Position ‣ Angle property, then the static angle of rotation is added to the variable angle of rotation (offset) when the visualization is executed.

Note

You can link the variables to a unit conversion.

Note

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

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.

See also

3.5.16.0

© Copyright 2021, CODESYS GmbH