Visualization Element: Histogram

Symbol:

Category: Measurement Controls

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

Element properties

Are all element properties available?

All properties are available only after you select the Advanced option or the All categories filter in Properties.

Element name

Example: GenElemInst_35

Tip

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

Element type

Histogram

Data array

One-dimensional array whose data is represented in this histogram

Example: PLC_PRG.arr1

Subrange of array

Use subrange

standard icon : 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 enabled.

Display

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: As the Display Type is Curve selected.
Show horizontal lines	: Horizontal lines are drawn on the main scale Note Not all visualization styles have this element property. For visualization styles that have a striped background, for example Flat style, this element property does not exist.
Relative bar width	. Integer value between `1` and `100` `1`: The bars are drawn as lines `100`: Total width of the histogram is filled with the bars.

Position

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

X	The X-coordinate (in pixels) of the upper left corner of the element Example: `10`
Y	The Y-coordinate (in pixels) of the upper left corner of the element Example: `10`
Width	Specified in pixels Example: `150`
Height	Specified in pixels Example: `30`

Tip

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

Scale

Scale start	Least value of the scale and the lower limit of the value range for the element Example: `0` Tip In the value field, click the symbol. Then the property is extended by the Variable property.
Variable	Variable (integer data type) for 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` Tip In the value field, click the symbol. Then the property is extended by the Variable property.
Variable	Variable (integer data type) for the scale end Example: `PLC_PRG.iScaleEnd`
Main scale	Distance between two values on the main scale Example: `10` Tip In the value field, click the symbol. Then the property is extended by the Variable property.
Variable	Variable (integer data type) for the spacing Example: `PLC_PRG.iMainScale`
Sub scale	Distance between two values on the fine scale You can hide the fine scale by setting the value to `0`. Example: `2` Tip In the value field, click the symbol. Then the property is extended by the Variable property. : The Variable property is displayed below it.
Variable	Variable (integer data type) for the spacing Example: `PLC_PRG.iSubScale`
Scale color	Color of the tick marks : Color Dialog : A list box 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 29. 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

Label

Unit	Text which is displayed in the element Example: Units displayed in m/s.
Font	Font for labels (example: scale numbering). Selection from the list box 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 The value is set automatically. Tip Change this value only if the automatic adjustment does not actually yield the expected result.
Text height of labels	Optional value that defines the maximum height of the scale label The value is set automatically. Tip Change this value only if the automatic adjustment does not actually yield the expected result.
Font color	Selection from the list box or by clicking the button.

Colors

Graph color	Color of the bar in normal state. Note The normal state is in effect when the actual value of the array element does not fulfill the alarm condition.
Alarm value	Threshold value for the alarm
Alarm condition	If the actual value of the array element fulfills the alarm condition, then the alarm condition is set. Less: The actual value is less than the Alarm value More: The actual 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	Start value on the Scale of the histogram where the color area begins
End of area	End value on the Scale of the histogram where the color area ends
Color	Color which is used for displaying the area

Center

	The properties contain fixed values for the coordinates of the point of rotation. The rotation point is displayed in the editor as the symbol and is used as the center for rotation and scaling. Tip You can also change the values by dragging the symbol to another position in the editor.
X	X-coordinate of the point of rotation
Y	Y-coordinate of the point of rotation

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. At runtime, the entire element is moved.

Movement
X	Variable (numeric data type) for the X-position (in pixels) Example: `PLC_PRG.iPos_X`. Container variable: `Container.Width` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element to the right.
Y	Variable (numeric data type) for the Y-position (in pixels) Example: `PLC_PRG.iPos_Y`. Container variable: `Container.Height` For more information, see: Optimally Adjusting the Position and Size Increasing this value at runtime moves the element downwards.
Rotation	Variable (numeric data type) for 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. At runtime, 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) to trigger a 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) for the angle of rotation (in degrees) Example: `PLC_PRG.iAngle2`. At runtime, 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.

Tip

You can combine the variables to a Unit conversion.

Tip

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

State variables

The variables control the element behavior dynamically.

Invisible

Variable (BOOL) for toggling the visibility of the element

TRUE: The element is not visible at runtime.

Tip

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

Animation

Tip

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

Variable for 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

Variable (BOOL) for setting the element in the foreground

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.

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

Permissions

Note

Available only when a user management is set up for visualization.

Access Rights button

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.