Visualization Element: Time Range Picker

Symbol:

Category: Date/Time Controls

The element provides configurable buttons for setting the time range of a trend display to a defined time. In the process the end time of the previous display is left unchanged and the start time is adapted.

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: `TimeRangeTemperature` Tip Assign individual names for elements so that they are found faster in the element list.
Element Type	Time range picker

Orientation

Orientation	Specifies whether the time picker element is aligned horizontally or vertically in the editor. Hint: Change the width to height ratio of the element in the editor.
Show frame	: The visualization element is drawn with a frame.
Resolution	Resolution saved for the time stamp: Millisecond or Microsecond
Attached element instance	Assignment to the element that processes the time picker The element can be assigned for example to a Trend visualization element. Then the time range of the trend element can be changed. The available visual elements are selected with the help of the Input Assistant. Example: `GenElemInst_1`

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.

Texts

Text	String (without single straight quotation marks) Example: `Main page %i` The element is labeled with this text. If a placeholder `%<format string>` is specified in the text, then the value of the variable in the Text variable → Text property is output at the location of the placeholder.

Tip

Use the Ctrl+Enter shortcut to add a line break.

Tip

The specified texts are automatically transferred to the GlobalTextList text list. Therefore, these texts can be localized.

Text properties

The properties get fixed values for the text properties and act on the texts configured in Texts → Text or Texts → Tooltip.

Font

Example: Default

: The Font dialog opens.

: List box with style fonts

Font color

Example: Black

: The Color dialog opens.

: List box with style colors

Transparency

Integer (value range from 0 to 255)

The transparent value determines the transparency of the respective color.

255: The color is opaque.

0: The color is completely transparent.

Note

If the color is a style color and already has a transparency value, then this property is write-protected.

Times

In Times, the buttons that the element provides at runtime are defined and configured as an array.

Provide "All" selection	: Extends the time selection bar with the All button The diagram represents a time interval that covers all time stamps.
Times	: Adds another button to the time selection bar and increases the array by one entry. An additional index exists below the Times → Times → Times → [<new>] property. Time is located under this index. The configuration of the button is to be entered there.
. Times [Index] with index ∈ {0, 1, 2,…}	Array of all buttons in the time selection bar. The Index corresponds to the number of buttons. : The associated button is removed from the time picker bar. The configuration entry is deleted from the Times property list.
. [Index] Time	: Time interval in standardized notation. Example: `3M` for 3 months; `30m` for 30 minutes. If a time interval is indicated in the field, then the button is labeled with it. If a user clicks on the button at runtime, the command is executed to switch the diagram to this time interval. The default is empty.

Control variables

Time

Variable (LINT) for a time (in µs)

Variable to programmatically control the selection of the time range.

Example:

For 1 s: liSelectedTimeIndex := 1000000;

For 30 s: liSelectedTimeIndex := 30000000;

All selected

Variable (BOOL)

Variable to programmatically control that all time ranges are enabled

TRUE: All time ranges are enabled.

FALSE: Not all time ranges are enabled here.

Example: PLC_PRG.xAllTimesAreSelected

Example 30. Example

PROGRAM PLC_ORG
VAR
	liSelectedTimeIndex : LINT := 1000000;
	bIsAllTimes : BOOL := TRUE;
END_VAR

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 can be assigned to 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 the following: 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 the following: 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.
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.