Versions Compared

Old Version 11

changes.mady.by.user Brandon Au

Saved on

compared with

New Version Current

changes.mady.by.user Brandon Au

Saved on

Key

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

Component Palette Icon:

On_this_page


A component filled with liquid that rises and falls as the Value property changes. Can be placed behind a symbol factor object that has a cutout in it.


Properties

NameDescriptionProperty TypeScriptingCategory
Background ColorThe color of the background. 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), Field Border, and Line Border.

Note_friendly

The border is unaffected by rotation.

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
Filled ColorSet the color of filled portion. See Color Selector .Color.foregroundAppearance
FontFont of text on this component.Font.fontAppearance
Font ColorThe foreground color of the component. See Color Selector .Color.fontColorAppearance
GradientIndicates whether the level will be drawn as a 3D gradient.boolean.gradientAppearance
Liquid WavesIndicate whether liquid waves are drawn.boolean.wavesAppearance
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
OrientationDetermines which direction the level "grows" for an increase in value.int.orientationAppearance
Percent FormatFormat string used for the percentage.String.percentFormatAppearance
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Show PercentageIndicates whether the percentage of tank filled is displayed.boolean.showPercentAppearance
Show ValueIndicates whether the numeric value, capacity, and units are displayed.boolean.showValueAppearance
StylesContains the component's styles.Dataset.stylesAppearance
UnitsUnits of measure for tank contents.String.unitsAppearance
ValueNumeric 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
Wave HeightThe height of each wave.int.waveHeightAppearance
Wave LengthThe length of each wave.int.waveLengthAppearance
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityData


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

Panel
titleLevel Indicator

Property NameValue
BorderLine Border
Value75
UnitsGallons
Show ValueTrue
GradientFalse
Filled Color0,100,240
FontArial Black, Plain, 16
Wave Height10
Wave Length15
Panel
titleLevel Indicator

Created using Symbol Factory Tanks > Tank with Rivets and Ladder. Then ungrouped twice. Fill paint set to 0,100,240.

Property NameValue
BorderLine Border
Value75
UnitsGallons
Show ValueTrue
GradientFalse
Filled Color0,100,240
Background Color250,250,251
FontArial Black, Plain, 16
Wave Height10
Wave Length15
Panel
titleSetting value through Scripting
Code Block
# You can set the component's value through scripting
event.source.parent.getComponent('Level Indicator').value = 5.4

# Alternatively, you can use the .setValue method to set the component's value
event.source.parent.getComponent('Level Indicator').setValue(5.4)