Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Component Palette Icon:

On_this_page


A component that looks like a 3D cylindrical tank with some liquid inside. The liquid rises and falls as the Value property changes.

Properties

NameDescriptionProperty TypeScriptingCategory
Background ColorThe 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.backgroundAppearance
Border
The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, and Line Border, and Other Border.
Note_friendly

The border is unaffected by rotation.

Editor_notes

Delete "Button Border" and "Other Border" from above list and make this visible upon 8.1.21 release

Changed_in
Version8.1.21


As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
CapacityTotal capacity of tank.double.capacityData
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
FontFont of text on this component.Font.fontAppearance
Font ColorThe color of the value and/or percentage labels. See Color Selector.Color.fontColorAppearance
Foreground ColorThe foreground color of the component. See Color Selector.Color.foregroundAppearance
Liquid ColorColor of the filled tank section. See Color Selector.Color.liquidColorAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Percent FormatFormat string used for the percentage.String.percentFormatAppearance
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
RotationThe angle of rotation in degrees.int.rotationAppearance
Show PercentageShow percentage of tank filled?boolean.showPercentAppearance
Show ValueShow numeric value, capacity, and units?boolean.showValueAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Tank ColorColor of the non-filled tank section. See Color Selector.Color.tankColorAppearance
UnitsUnits of measure for tank contents.String.unitsAppearance
Value

Numeric value of tank's level.

double.valueData
Value FormatFormat string used for the value.String.valueFormatAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

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. 

Examples

Panel
titleCylindrical Tank

Property NameValue
Value25
FontGeorgia, Bold 12
Liquid Color0,217,217
Show ValueTrue
Show PercentageFalse
Panel
titleSetting value through Scripting
Code Block
# 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)