Bar
(Engine-Level Function)
Deprecated. Do not use in new code.
| Description: | Draws a filled bar on the screen. |
| Returns: | Nothing |
Usage: ![]() |
Steady State only. |
| Function Groups: | Graphics |
| Related to: | Box | GUIRectangle | ZBox | Scale |
Format: ![]() |
Bar(X1, Y1, X2, Y2, Foreground, Pattern, Background) |
| Parameters: |
| X1 |
| Required. Any numeric expression giving the X coordinate one side of the bar on the screen (either left or right). |
| Y1 |
| Required. Any numeric expression giving the Y coordinate of either the top or bottom of the bar on the screen. |
| X2 |
| Required. Any numeric expression giving the X coordinate of the side of the bar opposite to X1 on the screen (either left or right). |
| Y2 |
| Required. Any numeric expression giving the Y coordinate of either the top or bottom of the bar, whichever is the opposite to Y1. |
| Foreground |
| Required. Any numeric expression giving the foreground VTScada Color Palette of the bar. |
| Pattern |
| Required. Any numeric expression giving the hatch pattern to use to fill the bar. The valid hatch style numbers are from 1 to 25 inclusive. A Pattern of 1 is a solid bar. For valid pattern numbers, please refer to Fill Patterns). |
| Background |
| Required. Any numeric expression giving the background color for the hatch pattern used to fill the bar. This value is only significant if the Pattern parameter is not equal to 1 (solid). |
Comments
This statement has been superseded by the GUIRectangle and ZBar statements, and is maintained for backwards compatibility only.
As of version 11, this is now drawn in the same z-order as other graphics, making it similar to the z-graphics functions.
It is recommended that you use bars without hatch patterns for animation, as solid bars are drawn faster.
