Vision - Cylindrical Tank
Component Palette Icon
A component that looks like a 3D cylindrical tank, with some liquid inside. The liquid rises and falls as the Value property changes.
Properties​
| Property | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Background Color | The background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector. | Color | .background | Appearance |
| Border | The border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border. Note: The border is unaffected by rotation. Changed in 8.1.21 As of 8.1.21, the "Button Border" and "Other Border" options are removed. | Border | .border | Common |
| Capacity | Total capacity of tank. | double | .capacity | Data |
| Cursor | The mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize. | int | .cursorCode | Common |
| Font | Font of text on this component. | Font | .font | Appearance |
| Font Color | The color of the value and/or percentage labels. See Color Selector. | Color | .fontColor | Appearance |
| Foreground Color | The foreground color of the component. See Color Selector. | Color | .foreground | Appearance |
| Liquid Color | Color of the filled tank section. See Color Selector. | Color | .liquidColor | Appearance |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String | .toolTipText | Common |
| Name | The name of this component. | String | .name | Common |
| Percent Format | Format string used for the percentage. | String | .percentFormat | Appearance |
| Quality | The data quality code for any Tag bindings on this component. | QualityCode | .quality | Data |
| Rotation | The angle of rotation in degrees. | int | .rotation | Appearance |
| Show Percentage | Shows percentage of tank filled when enabled. | boolean | .showPercent | Appearance |
| Show Value | Shows numeric value, capacity, and units when enabled. | boolean | .showValue | Appearance |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Tank Color | Color of the non-filled tank section. See Color Selector. | Color | .tankColor | Appearance |
| Units | Units of measure for tank contents. | String | .units | Appearance |
| Value | Numeric value of tank's level. | double | .value | Data |
| Value Format | Format string used for the value. | String | .valueFormat | Appearance |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Deprecated Properties​
| Property | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Data Quality | The data quality code for any Tag bindings on this component. | int | .dataQuality | Deprecated |
Scripting​
Component Functions​
This component does not have component functions associated with it.
Extension Functions​
This component does not have extension functions associated with it.
Event Handlers​
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page
Customizers​
Examples​
| Property Name | Value |
|---|---|
| Value | 25 |
| Font | Georgia, Bold 12 |
| Liquid Color | 0,217,217 |
| Show Value | True |
| Show Percentage | False |
Setting value through Scripting
# You can set the component's value through scripting
event.source.parent.getComponent('Cylindrical Tank').value = 5.4
# Alternatively, you can use the .setValue method to set the component's value
event.source.parent.getComponent('Cylindrical Tank').setValue(5.4)