Gauge Common Properties
This article describes properties that are available in all gauge types.
Basic Properties
Background Visible
Defines whether the background image is visible and will be painted.
Property name: backgroundVisible
Property type: Boolean
Background Color
Background color of the gauge (one of the pre-defined values).
Property name: backgroundColor
Property type: String
Custom Background
Custom frame design paint. This will be used if the Background Color property is set to Custom.
Property name: customBackground
Property type: Data Table
Foreground Visible
Enables/disables visibility of the glass effect foreground image. If enabled the foreground image will be painted.
Property name: foregroundVisible
Property type: Boolean
Orientation
The orientation of the gauge.
Property name: orientation
Property type: String
Value Coupled
Enables/disables automatic setting of gauge's LCD value when gauge primary value is changed.
Property name: valueCouples
Property type: Boolean
Auto Reset to Zero
Enables/disables the mode where the gauge will return to zero after a value was set. Means if you set a value the pointer will move to this value and after it reached the given value it will return back to zero.
Property name: autoResetToZero
Property type: Boolean
Standard Time to Value
The time in milliseconds that the pointer/bar/led needs to move from the minimum value of the gauge to the maximum of the gauge in standard mode. The minimum time is 250 ms and the maximum time is 5000 ms.
Property name: stdTimeToValue
Property type: Long
Time Back to Zero
The time in milliseconds that the pointer/bar/led needs back from the value to zero in autoreturn to zero mode. The minimum time is 250 ms and the maximum time is 5000 ms.
Property name: rtzTimeBackToZero
Property type: Long
Time to Value
The time in milliseconds that the pointer/bar/led needs to move from the minimum value of the gauge to the maximum of the gauge in autoreturn to zero mode. The minimum time is 250 ms and the maximum time is 5000 ms.
Property name: rtzTimeToValue
Property type: Long
Min Measured Value Visible
The visibility of the Minimal Measured Value indicator.
Property name: minMeasuredValueVisible
Property type: Boolean
Max Measured Value Visible
The visibility of the Maximal Measured Value indicator.
Property name: maxMeasuredValueVisible
Property type: Boolean
Value
Value to display on the gauge. Same value will be displayed in the gauge's LCD if Value Coupling option is enabled.
Property name: value
Property type: Double
Max Value
Sets the maximum value of the measurement range of this gauge. This value defines the maximum value the gauge could display.
Property name: maxValue
Property type: Double
Min Value
Sets the minimum value of the measurement range of this gauge. This value defines the minimum value the gauge could display.
Property name: minValue
Property type: Double
Frame Properties
This section describes properties of gauge frame.
Frame Visible
Enables/disables the visibility of the frame.
Property name: frameVisible
Property type: Boolean
Frame Design
The frame design of the gauge (one of the pre-defined values). The frame design is some kind of a color scheme for the frame of the component.
Property name: frameDesign
Property type: String
Frame Effect
The pseudo 3D effect of the frame.
Property name: frameEffect
Property type: String
Frame Base Color Enabled
Enables/disables usage of the Frame Base Color to colorize the Shiny Metal Frame Design.
Property name: frameBaseColorEnabled
Property type: Boolean
Frame Base Color
Color that will be used to colorize the Shiny Metal Frame Design.
Property name: frameBaseColor
Property type: Color
Custom Frame Design
Custom paint that will be used if Frame Design property is set to Custom.
Property name: customFrameDesign
Property type: Data Table
Glow Properties
This section describes properties of gauge glow effect.
Glow Visible
Enables/disables the glow indicator.
Property name: glowVisible
Property type: Boolean
Glow Pulsating
Enables/disables the pulsating of the glow effect.
Property name: glowPulsating
Property type: Boolean
Glowing
Enables/disables glowing of the glow indicator.
Property name: glowing
Property type: Boolean
Glow Color
The color that will be used for the glow indicator.
Property name: glowColor
Property type: Color
LED Properties
This section describes properties of gauge LEDs. Each gauge may have up to two LEDs: a threshold LED and a user-controlled LED.
Led Visible
Enables/disables visibility of the threshold LED (one of the pre-defined values).
Property name: ledVisible
Property type: Boolean
Led Color
The color of the threshold LED.
Property name: ledColor
Property type: String
User Led Visible
Controls the visibility of the user LED.
Property name: userLedVisible
Property type: Boolean
User Led on
Switches the user LED on or off.
Property name: userLedOn
Property type: Boolean
User Led Blinking
Enables/disables blinking of the user LED.
Property name: userLedBlinking
Property type: Boolean
User Led Color
The color of the user LED (one of the pre-defined values).
Property name: userLedColor
Property type: String
Led Position
The position of the gauge threshold LED defined as (X, Y) values. The X and Y should be in range 0...1 as they indicate LED position within the gauge space.
Property name: ledPosition
Property type: Data Table
User Led Position
The position of the gauge user-controlled LED defined as (X, Y) values. The X and Y should be in range 0...1 as they indicate LED position within the gauge space.
Property name: userLedPosition
Property type: Data Table
Scale Properties
This section describes properties of gauge scale.
Tick Marks Visible
Enables or disables the visibility of the tickmarks.
Property name: tickmarksVisible
Property type: Boolean
Tick Mark Sections Visible
Controls the visibility of the tickmark sections.
Property name: tickmarkSectionsVisible
Property type: Boolean
Tick Mark Sections
A list of tickmark sections. The sections are defined by a start value, a stop value, a color, and highlight color. This might be a useful feature if you need to have exactly defined areas that you would like to visualize by the colored tickmarks.
Property name: tickmarkSections
Property type: Data Table
Tick Mark Color from Theme Enabled
Enables/disables usage of a separate color for the tickmarks.
Property name: tickmarkColorFromThemeEnabled
Property type: Boolean
Tick Mark Color
The color of the tickmarks and their labels.
Property name: tickmarkColor
Property type: Color
Tick Labels Visible
Enables or disables visibility of the tickmark labels.
Property name: ticklabelsVisible
Property type: Boolean
Label Number Format
Number format that will be used to display labels of the tickmarks. The following formats are available: Auto, Standard, Fractional and Scientific.
Property name: labelNumberFormat
Property type: String
Minor Tickmark Visible
Enables/disables the visibility of the minor tickmarks.
Property name: minorTickmarkVisible
Property type: Boolean
Minor Tickmark Type
Current type of tickmarks that is used for minor tickmarks. Value could be Line (default), Circle, Triangle or Square.
Property name: minorTickmarkType
Property type: String
Minor Tick Spacing
Spacing between the minor tickmarks if the Nice Scale property is disabled.
Property name: minorTickSpacing
Property type: Double
Major Tickmark Visible
Enables/disables visibility of major tickmarks.
Property name: majorTickmarkVisible
Property type: Boolean
Major Tickmark Type
Current type of tickmark that is used for major tickmarks. Value could be Line (default), Circle, Triangle or Square.
Property name: majorTickmarkType
Property type: String
Major Tick Spacing
Spacing between major tickmarks if the Nice Scale property is disabled
Property name: majorTickSpacing
Property type: Double
Nice Scale
Enables/disables the calculation of "nice" values for the min and max values of the scale.
Property name: niceScale
Property type: Boolean
Log Scale
Enables/disables logarithmic scaling for the axis.
Property name: logScale
Property type: Boolean
Max Number of Minor Ticks
Maximum number of minor tickmarks.
Property name: maxNoOfMinorTicks
Property type: Integer
Max Number of Major Ticks
Maximum number of major tickmarks.
Property name: maxNoOfMajorTicks
Property type: Integer
Track Properties
Track is an area that could be defined by a start value, a section value, and a stop value. This area will be painted with a gradient that uses two or three given colors. E.g. a critical area of a thermometer could be defined between 30 and 100 degrees celsius and could have a gradient from green over yellow to red. In this case the start value would be 30, the stop value would be 100 and the section could be somewhere between 30 and 100 degrees.
The track can be used in addition to gauge Areas and Sections.
Track Visible
Controls visibility of the track.
Property name: trackVisible
Property type: Boolean
Track Start
Value where the track will start.
Property name: trackStart
Property type: Double
Track Start Color
Color of the point where the track starts.
Property name: trackStartColor
Property type: Color
Track Section
Value of the middle point between Track Start and Track Stop.
Property name: trackSection
Property type: Double
Track Section Color
Color of the track section (middle) point.
Property name: trackSectionColor
Property type: Color
Track Stop
Value where the track will end.
Property name: trackStop
Property type: Double
Track Stop Color
Color of the point where the track ends.
Property name: trackStopColor
Property type: Color
Title Properties
This section describes properties of gauge title and unit labels.
Title and Unit Font Enabled
Enables and disables usage of a custom title and unit label font.
Property name: titleAndUnitFontEnabled
Property type: Boolean
Title
Title of the gauge, e.g. "Temperature".
Property name: title
Property type: String
Title and Unit Font
Font that will be used for the title and unit labels.
Property name: titleAndUnitFont
Property type: Data Table
Unit String
Unit string of the gauge, e.g. [cm].
Property name: unitString
Property type: String
Label Color from Theme Enabled
Enables/disables usage of a separate color for the title and unit labels.
Property name: labelColorFromThemeEnabled
Property type: Boolean
Label Color
Color of the title and unit labels.
Property name: labelColor
Property type: Color
Threshold Properties
This section describes properties of gauge's threshold indicator.
Threshold Visible
Controls visibility of the threshold indicator.
Property name: thresholdVisible
Property type: Boolean
Threshold
Value at that the threshold indicator is displayed.
Property name: threshold
Property type: Double
Threshold Type
Type of the threshold indicator (Arrow or Triangle).
Property name: thresholdType
Property type: String
Threshold Color
Color of the threshold indicator (one of the pre-defined values).
Property name: thresholdColor
Property type: String
Threshold Behaviour Inverted
Enables/disables inversion of the threshold behaviour.
Property name: thresholdBehaviourInverted
Property type: Boolean
Area Properties
Areas are visual pie sections of a gauge that visualize certain value ranges. Areas can be used in addition to gauge Track and Sections.
Areas Visible
Controls visibility of the areas.
Property name: areasVisible
Property type: Boolean
Areas
List of the areas. Each area is defined by a start value, a stop value, and a color.
Property name: areas
Property type: Data Table
Highlight Area
Enables/disables highlighting of the area that contains the current value.
Property name: highlightArea
Property type: Boolean
Areas 3D Effect Visible
Controls 3D-like appearance of areas.
Property name: areas3DEffectVisible
Property type: Boolean
Transparent Areas Enabled
Enables/disables usage of a transparent color for filling areas.
Property name: transparentAreasEnabled
Property type: Boolean
Section Properties
Sections are colorized parts of gauge's scale. Sections can be used in addition to gauge Track and Areas.
Sections Visible
Controls visibility of the sections.
Property name: sectionsVisible
Property type: Boolean
Sections
List of the sections. Each section is defined by a start value, a stop value, a color, and a highlight color.
Property name: sections
Property type: Data Table
Section Tick Marks only
Controls whether only tickmarks of the sections are visible.
Property name: sectionTickmarksOnly
Property type: Boolean
Highlight Section
Enables/disables highlighting of the section that contains current value.
Property name: highlightSection
Property type: Boolean
Section 3D Effect Visible
Controls 3D-like appearance of sections.
Property name: section3DEffectVisible
Property type: Boolean
Transparent Sections Enabled
Enables/disables the usage of a transparent color for filling sections.
Property name: transparentSectionsEnabled
Property type: Boolean
LCD Properties
Each gauge may display an LCD-like display with numeric presentation of gauge value. This section describes LCD display properties.
LCD Visible
Enables or disables visibility of the LCD display.
Property name: lcdVisible
Property type: Boolean
User LCD Value
If gauge's Value Coupling flag is disabled, LCD will display separate numeric value defined by this property.
Property name: lcdValue
Property type: Double
Color
Background color of the LCD display.
Property name: lcdColor
Property type: String
Decimals
Number of decimal digits that will be used to visualize values in the LCD display.
Property name: lcdDecimals
Property type: Integer
Info String
Arbitrary text displayed on the top of LCD display.
Property name: lcdInfoString
Property type: String
Info Font
Font used to display the Info String.
Property name: lcdInfoFont
Property type: Data Table
Number System
Number system that will be used to display the current LCD value (Decimal, Hexadecimal, or Octal).
Property name: lcdNumberSystem
Property type: String
Scientific Format
Enables/disables the scientific format of LCD value.
Property name: lcdScientificFormat
Property type: Boolean
Threshold Visible
Enables/disables visibility of the LCD threshold indicator.
Property name: lcdThresholdVisible
Property type: Boolean
Threshold
Value of the LCD indicator's threshold.
Property name: lcdThreshold
Property type: Double
Threshold Behaviour Inverted
Enables/disables inversion of the LCD threshold behaviour.
Property name: lcdthresholdBehaviourInverted
Property type: Boolean
Unit String Visible
Enables/disables visibility of the unit string in the LCD display.
Property name: lcdUnitStringVisible
Property type: Boolean
Value Font
Font that will be used to visualize the value on the LCD display.
Property name: lcdValueFont
Property type: Data Table
Unit String
Text of unit label displayed on the LCD.
Property name: lcdUnitString
Property type: String
Unit Font
Font that will be used to visualize the unit label on the LCD display.
Property name: lcdUnitFont
Property type: Data Table
Digital Font
Enables/disables usage of the digital font in the LCD display.
Property name: digitalFont
Property type: Boolean
Was this page helpful?