Canvas > Using Canvas Controls and Objects > Linear Gauge

Linear Gauge (Horizontal) and Linear Gauge (Vertical)

Linear Gauge Horizontal icon Linear Gauge Vertical icon The two Linear Gauge controls are CygNet-aware tools, which display real-time point data on a horizontal or vertical object. Two separate controls are supported: the Linear Gauge (Horizontal) the Linear Gauge (Vertical). Data is represented by a bar that fills the control to a calculated value between a lower and upper bound. The source of the lower value bound and upper value bound can be either hard-coded to an explicit value, or dynamically determined for each facility by sourcing the value from an application-specific attribute of the associated point (using an Indexed field, or a General data field). A guage on a templated screen supports different bounds for each source facility. By using a point attribute to store the bounds (for example, Indexed 1 for the lower value bound and Indexed 2 for the upper value bound), you can have a templated screen without having to script the control. Both linear gauges support a linear or logarithmic scale, with the scale values displayed along the bar from the lower to upper bound. A primary scale is displayed on the right side (Vertical) or bottom side (Horizontal) showing major and minor ticks. A secondary scale is displayed on the left side (Vertical) or top side (Horizontal) showing the lower and upper bound values. An optional text label based on point or facility attributes is centered below the vertical gauge or centered along the horizontal gauge. The control can display static text, such as a label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. The color of the linear gauges' background, text label, the bar representing the value, and the empty bar portion can be explicitly configured or sourced from the point state of the associated point. Colors in the control can be overridden when a custom color palette is selected for the screen. Font sizing, text styling, and text weighting are also configurable. Date, time, and value formatting for the text displayed on the control is supported. The control can be hidden if the associated point is invalid. This control supports tooltips, which can be displayed as tokenized text, a Canvas object, or the tooltip can be scripted to retrieve and display values for related points or CygNet notes. A context menu is available in run mode with access to CygNet point and alarm data, including alarm acknowledgment, current and history values, point and facility configuration, and trending point data on a default chart.

Canvas Linear Gauge Control

Sample vertical and horizontal linear gauge controls
with data passed in from tag chooser

Property Inheritance

Property Inheritance

Property inheritance is a widely used concept in Canvas. The application supports an explicit relationship between screens, objects, and controls, where certain property values, such as SiteService and facility tags, are passed from one element to another via an inheritance framework. Screens, objects, and controls can be configured as property senders or property receivers and provide configuration options where you can explicitly define the source of the SiteService and facility. Depending on how you have your screens, objects, and controls set up, the SiteService and facility may come from any one of the following sources:

Broadcasting

Screens and objects support an additional notification option to broadcast their SiteService and facility selection changes to other open screens running in the Canvas or Canvas View application. If configured, a <Broadcast> option is available to source the screen's SiteService and facility properties from another open screen.

For example, a text tool can be configured to get its facility from the screen and the screen can be configured to get its facility from a tag chooser. Or Screen_A might source its facility from Screen_B, which gets its facility from a tag chooser.

Receiver or Sender

The Linear Gauge controls support property inheritance as a receiver of their SiteService and facility:

Receive from Send to
SiteService Facility SiteService Facility

Self

Screen

Self

Screen

Other controls

none

none

The Linear Gauge controls does not send their SiteService or facility to other controls.

Related Topics


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.