Bargraph Widget (BarGraph.class)

A Bargraph Widget is a live bargraph that represents the byte (or word) value returned from a function call. The bargraph moves from left-to-right, right-to-left, bottom-to-top, or top-to-bottom.

Bargraph Parameter Attributes:

Parameter="invisible" value="CHECKED" or "UNCHECKED" — Specifies if the Bar Graph is to start out invisible or not. If the attribute is UNCHECKED, then by default the Bar Graph is visible. If the Bar Graph starts out invisible, the only way to make it visible again is via the IWC method reappear().

Parameter="fillColor" value= See color entry conventions — Specifies the desired bargraph fill color. See section on colors for more information. If no fill color is specified, the default color is black. If the alpha is FF, then the fill color is fully opaque.

Parameter="borderColor" value= See color entry conventions — Specifies the desired bargraph border color. See section on colors for more information. If no border color is specified, the default color is the fillColor color. If the alpha is FF, then the border color is fully opaque.

Parameter="backgroundColor" value= See color entry conventions — Specifies the desired bargraph background color. See section on colors for more information.  If no background color is specified, the default color is white. if the alpha is FF, then the background color is fully opaque.

Parameter="href" value="function" — The function called to retrieve the widget input. See Appendix B for all available functions for the Bargraph Widget. The function is called at an update rate specified by the updateFreq attribute.

Parameter="min" value="number" — Minimum value returned from the href function; must be less than max. If the function returns a byte, the range is 0 - 254 (0x00 - 0xFE). If the function returns a word, the range is 0 - 65534 (0x00 - 0xFFFE).

Parameter="max" value="number" — Maximum value returned from the href function; must be greater than min. If the function returns a byte, the range is 1 - 255 (0x01 - 0xFF). If the function returns a word, the range is 1 - 65535 (0x01 - 0xFFFF).

Parameter="sweepFrom" value="LEFT" or "RIGHT" or "TOP" or "BOTTOM" — Determines where to begin drawing the bargraph. The options are:

• LEFT — The bargraph is drawn from left-to-right. (default)
• RIGHT — The bargraph is drawn from right-to-left.
• TOP — The bargraph is drawn from top-to-bottom.
• BOTTOM — The bargraph is drawn from bottom-to-top.

Parameter="updateFreq" value ="number" — The number specifies the href function call frequency (specified in seconds, with a single floating-point number). The range is 0.00 - 655.35. A value of 0.00 means update never.

Parameter="updateDelay" value ="number" — The number specifies the delay time from when the page is loaded until the first href function call (specified in seconds, with a single floating-point number). The range is 0.00 - 655.35. If this number is not specified, then the delay time defaults to updateFreq number.

Optional Bar Graph Parameter Attributes:

Parameter="waitForInit" value="CHECKED" or "UNCHECKED" — Specifies if the Bar Graph will wait for valid data before being displayed. If CHECKED, the Bar Graph will not display until the data from the href function is received. If UNCHECKED, or the attribute is not present, the Bar Graph momentarily starts at the min location until the href function receives its data. If waitForInit not specified, the default is UNCHECKED.