The Detail control is a CygNet-aware single-value control that displays real-time data for a single point in multiple formats within the same control. The control contains six elements:
| 1. – 3. | three tokenized text strings (top, middle and bottom). The control can display a static text string, such as a label, legend, tooltip, or a dynamic text string 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. In run mode, the tokens are replaced with the attribute's value. |
| 4. | an alarm icon that can be configured to change color based on point state and change image based on alarm priority  |
| 5. | a small sparkline with live updates of real-time data, configurable line color, x- and y-axis ranges and min/max values, and date ranges, both relative and absolute |
| 6. | an arrow used to flip the Detail control when clicked and display a Canvas object of your choosing on the reverse side of the Detail control. The object on the reverse side will receive its point and facility configuration from the Detail control. |
The last three elements (alarm icon, sparkline, and flip icon) can be toggled on or off.
Several other configurable properties are supported, including:
- The control's color elements can be set to one of the following options: a) automatically follow the selected application theme regardless of the underlying color palette used, b) sourced from the point state color defined for the associated point, or c) be explicitly configured. (The sparkline's color is not theme specific.)
- Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
- Date, time, and value formatting for the text displayed on the control is supported.
- The control optionally can be hidden if the associated point tag is invalid.
- Font sizing, text styling, and text weighting are also configurable.
- 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.
- In the Canvas Native view a context menu is available at runtime 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. Custom context menu items can be scripted allowing customized control behavior.
- In the CygNet TWC web view a context menu is available with access to CygNet point and alarm data, including current value details, alarm acknowledgment, alarm summary, and trending point data on a quick chart. The TWC context menu also supports adding any CygNet point presented in the main web view to an ad hoc chart.
This control is supported in the Canvas Native view and the CygNet TWC web view.
Objects in the Thin Web Client
Canvas object files (.cob) are generally not supported in the CygNet Thin Web Client, with the exception of an object file used as the reverse side of the Detail control when flipped. Object files created for this purpose must following the TWC naming and storage rules: no spaces in the file name, no special characters, and the .cob file must be saved in a BSS folder, preferably in the same folder as the screen file with the Detail control. Note that while many of an Object's properties are visible in the Canvas user interface, they may not be supported in an object file created for a Detail control. Consult the Object Properties topic for more information.
Detail Example
The following image shows a Tag Chooser and two Detail controls.
|
The image on the left shows a Detail control with the facility passed in from the Tag Chooser (Canyon Well). |
Property Inheritance
Property Inheritance
Property inheritance, or sending and receiving, is a widely used concept in Canvas. The application supports an explicit relationship between screens, objects, and controls, where certain property values, such as facilities and SiteService details, 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 facility and SiteService. Depending on how you have your screens, objects, and controls configured, the facility and SiteService may be received from any one of the following sources:
- from itself — indicated by selecting <Self> and then explicitly configuring the property
- received from the screen — indicated by selecting Screen, which is always present as a sender
- received from another control — indicated by selecting the Name of the sending control.
Broadcasting
Screens and objects support an additional notification option to broadcast their facility and SiteService selection changes to other open screens. If configured, a <Broadcast> option is available to source the screen's facility and SiteService 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 Detail control supports property inheritance as a receiver of its SiteService and facility:
| Receive from | Send to | ||
|---|---|---|---|
| SiteService | Facility | SiteService | Facility |
| self screen |
self screen other controls |
none | none |
The Detail control does not send its SiteService or facility to other controls.
