Table of Contents
Box
com.ergotech.vib.graphics.Box
Image Examples
 |  |
| Box in the graphics palette. | Box graphic example. |
Overview
The Box graphic is a basic Active Graphic used to display values, text, and fill-style visual indicators.
A Box can display formatted numbers or strings. When the input value is numeric, the Box can also fill based on the value, scaled between the configured minimum and maximum values.
The Box is useful as a simple display component, a dashboard layout element, a status indicator, or a fillable shape.
Common Uses
- Displaying a number or string value
- Creating a fillable bar or level indicator
- Showing a simple status display
- Creating visual sections on a dashboard
- Building simple bar-style displays
- Creating a tank-style level display when combined with an appropriate bezel or panel style
Input Behavior
The Box input accepts Value Objects.
If the input value is numeric, the Box can display the value as text and can also fill based on the value. The fill amount is scaled between the configured minimum and maximum values.
If the input value is a string, the Box can display the string as text.
If the input is an Array Value Object, the Box displays the number of elements in the array. The fill amount can also be based on the number of array elements. For example, with the default scale of 0 to 100, an array with 50 elements would fill the Box to about 50%.
If the input is a Two Dimensional Value Object, the Box displays the array dimensions in the form [n,m], where n is the number of arrays and m is the number of elements in each array.
Basic Properties
The Box uses many common Active Graphic properties. See Active Graphic for shared properties such as Name, Visible, font settings, number formatting, scaling limits, bezels, transparency, and click behavior.
Box-Specific Properties
Server Color Action Determines whether the color from the input Value Object is used for the fill area, unfilled area, label, or not used.
Color For Fill Sets the color used for the filled portion of the Box.
Color For UnFilled Sets the color used for the unfilled portion of the Box.
Fill Direction Controls the direction or style of the fill. Options may include None, Top, Left, Bottom, Right, Boolean Fill, or All.
Label Color Sets the label color when Use Label Color is enabled.
Label Format Controls how numeric values are displayed.
Label Horizontal Alignment Controls whether the label is aligned left, right, or centered.
Label Vertical Alignment Controls whether the label is aligned top, bottom, or centered.
Maximum Value Sets the input value used for 100% fill.
Minimum Value Sets the input value used for 0% fill.
Show Label Controls whether the text label is displayed.
Use Label Color Controls whether the selected Label Color is used. If this is not enabled, the label color may be determined automatically based on the fill and unfilled background colors.
Fill Behavior
The Box can act like a fillable shape. This makes it useful for simple bar displays, level displays, and status indicators.
For example, a vertical Box with the label hidden can be used like a simple bar chart element. Multiple Boxes can be placed side by side to create a simple bar display.
A Box can also be configured to resemble a tank level display by using an appropriate panel or bezel style, hiding the label, and connecting a numeric data source.