OAS ValueBox Widget

The ValueBox widget is designed to support the visualization of process values showing the current state of the plant. Inspired by the BLabel widget the ValueBox provides some handy feature making it easier to show the state of overridden values or even manually locked values from IO Modules. Also the ValueBox is much simpler to configure due to its simpler set of properties. E.g. the text will always be shown in the center of the ValueBox.

Slots

Name	Type	Default
background	Brush	`#e9ececf`
borderColor	Brush	`transparent`
font	Font	`bold 12.0pt Source Sans Pro`
foreground	Brush	`#6363636`
lockedStatus	boolean	`false`
overrideStatus	boolean	`false`
showIOStatus	boolean	`false`
value	String	`"--"`

background

Handles the color with which the background is displayed. Due to its chosen type the background property provides a solid color, a gradient or an image. It’s important to know that even all of those options are available it’s recommended to only use the solid option because the other two are not thoroughly tested.

borderColor

This property is a simplified border property. It only provides the possibility to change the color of the border not the thickness nor the line style (the thickness is set to 2.4 and the line style is set to BBorder.SOLID).

font

Changes the font to display the value text.

foreground

Defines the color in which the value text will be shown.

lockedStatus

If the showIOStatus is enabled and the lockedStatus is true the key icon will be shown on the right side of the ValueBox. For more info about this topic visit the Locked and Override Status Page.

overrideStatus

If the showIOStatus is enabled and the overrideStatus is true the hand icon will be shown on the right side of the ValueBox. For more info about this topic visit the Locked and Override Status Page.

showIOStatus

Controls the visibility of the hand and key icon for the ValueBox. Will decrease the width of the box showing the value by 24px to make room for the icons. Until this property is set to true the overrideStatus and lockedStatus have no effect.

value

Is responsible for the text be shown in the center of the ValueBox. The font property changed the look and the size of the text. When getting a instance from the palette or the new Widget menu this property is already animated via an ValueBindung. The ValueBinding is using the Format %out.value% for full facet support like precision and unit.

Common / Intended use

The common use case of the ValueBox widget is to be shown process data like temperatures, pump operation etc. That said long texts are not intended even though the ValueBox can be stretched to show longer text, there is no text wrap to display Text in a second line. With this in mind the default ValueBox comes with a ValueBindung for the value property showing the Format %out.value% which will show the value of the bound component according to the facets defined. Next you have to decide if you want show the hand (overrideStatus) and the key (lockedStatus) icons to the right of the ValueBox? If so set the showIOStatus to true. To dynamically show or hide the icons you animate the respective slots e.g. the overrideStatus gets animated via a BIStatusToSimple Converter. In the same fashion the borderColor can be used to visualize the Status of the bound component. By animating the Brush property borderColor with the BIStatusToBrush Converter the ValueBox border Color will be set to the highest status present on the component’s out slot.

It is also possible to use the ValueBox to display values that are overridable. Then the Popup Binding could be added to the ValueBox enabling a HTML5 Popup on click.