Using Canvas Controls and Objects

This topic introduces the Canvas controls and objects.

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [H]     [I]     [L]     [M]     [N]     [O]     [R]     [S]     [T]     [U]     [V]     [W]    

Name Type
CygNet
Aware
Single
Value
TWC Description

Alarm Grid

Grid

CygNet Aware

 

Supported by TWC

Alarm Grid icon The Alarm Grid is a CygNet-aware control that supports the creation of customizable and interactive tables for the display and management of large amounts of alarm data in columns and rows. Five customizable column types are supported: Alarm, Facility, Generic, Point, and a column displaying an alarm icon, which can be customized based on alarm priority for unacknowledged alarms. Alarm columns are mapped to an alarm attribute; facility columns are mapped to a facility attribute; generic columns can display any kind of scripted data of your choice and its cells can be edited in run mode; and point columns are mapped to point attribute. Point columns also support grid row summaries. Several other configurable properties are supported, including:

  • Custom alarm filters that apply to the whole grid can be configured to limit grid data.
  • A toolbar containing dynamic filters to limit data in run mode can be added to the top of the Alarm Grid. You can select multiple filters to limit the data in different ways.
  • The Alarm Grid can be configured as a SiteService or facility receiver so that you can indicate where the Alarm Grid is receiving its data. Data can be sourced either from a SiteService (received from the screen or the Common Alarm Service (CAS)) or from facilities (received from the screen or from another control on the screen).The grid can be configured as a facility sender, responding differently when a row is clicked. It can send facilities from grid to grid, from a grid to other controls or your current screen, or from a grid to other controls on a different hyperlinked screen.
  • This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close.
  • Cell background color, text color, and border color can be set to one of the following options: a) sourced from the colors configured in the CygNet point scheme for single color, foreground color, or background color, b) automatically follow the selected application theme regardless of the underlying color palette used, or c) be explicitly configured.
  • Header background color, header text color, and grid background color can be set to one of the following options: a) automatically follow the selected application theme regardless of the underlying color palette used, or b) be explicitly configured.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • You can configure whether to display alarm acknowledgment as a blinking cell background, blinking text, or blinking border when a point is in alarm.
  • In the Canvas Native view a context menu is available in run mode to facilitate alarm acknowledgment, alarm clearing, alarm hiding, and ad hoc alarm suppression.
  • 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.

Button

Common

CygNet Aware

Single Value

 

Not supported by TWC

Button icon The Button is a CygNet-aware single-value control that can be used to add square or rectangular forms to your screens, which can be easily scripted to manage user interaction with CygNet data, for example, trigger an event, confirm an action, interact with other screen controls or other screens, or even start other applications. 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. The control can be configured with a valid point configuration but prevented from retrieving any CygNet data, allowing the display of static text while still allowing CygNet data context available from script. 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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Alarm indication (blinking) is supported for the button's background, text, and border when the associated point is in alarm.
  • 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.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.
  • 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.
  • Buttons also support the addition of an image.

Chart

Chart

CygNet Aware

 

Supported by TWC

Chart icon The Chart is a CygNet-aware control that provides a customizable means to visualize point values and historical CygNet data in several types of charts. The Canvas chart is highly configurable and supports the following options:

  • an unlimited number of y-axes that can be styled as desired
  • an unlimited number of series that can be styled as desired, optionally displaying historical rollup values
  • hide or show data points marked as unreliable
  • configurable date ranges, both relative and absolute
  • live data updates at a configured interval allowing the chart to trend data at a real-time pace
  • the display of time slices and tooltips
  • optional, configurable legend options (date and value format, dynamic text display based on real-time properties, or series Name)
  • configurable x- and y-axis features (label color, position, tick color, and title)
  • a configurable toolbar (position, live update toggle buttons, configure time range, any number of quick range buttons, and other functional buttons)
  • dragging, panning, and zooming in run mode
  • support for native CygNet data and non-CygNet data via script.

Other run-mode options include stopping/restarting live updates, changing the date and time range, saving/opening a chart's configuration as a default chart, printing the current chart, export as an image, and export data to a .csv (Comma Separated Values) file.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Check Box

Common

 

 

 

Not supported by TWC

Check Box icon The Check Box can be used for a singular true or false option on a screen. Multiple Check Boxes may be added to any screen, but they operate independently of each other. The Check Box can be configured to display in a checked (true) state. You can also add a label to appear on the left or right of the Check Box and the font size of the label is customizable. Script is required to facilitate user interaction with a Check Box object.

Combo Box

Common

 

 

 

Not supported by TWC

Combo Box icon A Combo Box provides a drop-down menu control for your screens, where a user may select one among a list of mutually exclusive values. The list of items in the drop-down menu is defined using the Combo Box's Items property. Each item in the drop-down menu has a Label and a Value, either of which can be called in script to facilitate user interaction. You can configure the list to default to the first item and add some explanatory text to guide your users when no option has been selected. The background color of the Combo Box's header and the color of the text in the Combo Box list are configurable. The control's color elements can be set to automatically follow the selected application theme regardless of the underlying color palette used or explicitly configured. Font sizing, text styling, and text weighting are also configurable.

CygNet Grid

Grid

CygNet Aware

 

Supported by TWC

Grid icon The CygNet Grid is a CygNet-aware control that supports the creation of customizable and interactive tables for the display and management of large amounts of data in columns and rows. Five customizable column types are supported: Facility, Generic, History, Image, and Point: facility columns are mapped to a facility attribute and can resolve to a relative facility; generic columns can display any kind of scripted data of your choice and its cells can be edited in run mode; history columns are used to add a sparkline chart in each cell for a specified UDC. An image column presents a point-state image — a CygNet-aware image that will dynamically change based on the point state of the associated point. A default image is displayed if you configure point-state-aware images and no matching state exists. Point columns are mapped to a UDC and point attribute, and the color 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 point represented in the row, or c) be explicitly configured. Point columns also support grid row summaries. Several other configurable properties are supported, including:

  • The facility and SiteService are configured for the grid row and each can be explicitly set (and filtered) or sourced from other another control or the screen.
  • Alarm indication (blinking) is supported for a point column's background, text, and border when the associated point is in alarm.
  • The grid can be configured as a facility sender, responding differently when a row is clicked. It can send facilities from grid to grid, from a grid to other controls or your current screen, or from a grid to other controls on a different hyperlinked screen.
  • This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close.
  • A grid's header background color, header text color, and grid background color can be configured to one of the following options: a) automatically follow the selected application theme regardless of the underlying color palette used, or b) be explicitly configured.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • 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.
  • Each cell in a CygNet Grid is like a Text Tool and the two controls share many color and point configuration properties.

The CygNet Grid is sometimes called the Value Grid.

This control is supported in the Canvas Native view and the CygNet TWC web view.

DDS Button

DDS

CygNet Aware

 

Supported by TWC

DDS Button icon The DDS Button is a DDS-aware control that can be used to get and send data group transaction data (data group element Ids (DEIDs)) from a remote device for display on a screen.

By default, data group transaction records are saved only in the DDS for a short time, unless you've mapped one or more data group elements from a data group to UDCs and points for retention in the UIS and historicization in the VHS. Canvas supports three DDS-based controls that can read and write data group transactions:

These DDS-based controls are an efficient way to create transaction-based screens for displaying and manipulating data group information for remote devices. Use these controls to implement a scriptless solution for creating screens where data is encapsulated in a transaction, but not mapped to a CygNet point. For example, you could make a lift management screen for plungers or other device types in your CygNet environment.

The DDS Button takes advantage of Canvas' sending and receiving model and can receive its facility from any sender on the Canvas screen, for example, a Tag Chooser or a CygNet Grid, or any other facility sender. The source facility configured for (or passed to) the DDS Button is used to determine the associated remote device, and from the remote device, the device type can be ascertained. Then based on the resolved device type, the configured data group (type and ordinal) is used to issue the appropriate transaction request to the remote device and complete the operation at runtime.

The DDS Button supports two transaction types, Get and Send. When a user clicks a DDS Button the following actions will happen, depending on the configuration:

  • Get — Poll the remote device associated with the configured facility, retrieve the requested transaction data, and then populate any linked DDS Text Tools and/or DDS Edit Boxes with the specified data element Id.
  • Send — Send any edited data element Ids in a linked DDS Edit Box down to the remote device.

The DDS-based controls can be used as a template, meaning they are multiple device-type aware. For example, Device Type A may have a data group called "BasicPoll", but Device Type B may have a similar data group called "Status." In the case where the data group "function" is the same, but the name is different, the controls can handle this difference. The normalization process (handled in other controls via UDC specification) is handled via the Device type specification:

  • The DDS Button control supports configuration of Device type, Data group type, and Ordinal.
  • The DDS Edit Box controls support configuration of Device type, and Data element Id. The display type is assumed to be the DEID Value.
  • The DDS Text Tool controls support configuration of Device type, and Data element Id, and Display type (Value or Description).

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 via <Auto>, or b) be explicitly configured via <Self>.
  • Colors displayed 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.
  • Buttons also support the addition of an image.
  • The mouse cursor that appears when the mouse hovers over the control is 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.

The button shares many properties, events, and methods with the standard Canvas Button control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

DDS Edit Box

DDS

CygNet Aware

 

Supported by TWC

Edit Box icon The DDS Edit Box is DDS-aware control that can be used to get and send data group transaction data (data group element Ids (DEIDs)) from and to a remote device for display on a screen.

By default, data group transaction records are saved only in the DDS for a short time, unless you've mapped one or more data group elements from a data group to UDCs and points for retention in the UIS and historicization in the VHS. Canvas supports three DDS-based controls that can read and write data group transactions:

These DDS-based controls are an efficient way to create transaction-based screens for displaying and manipulating data group information for remote devices. Use these controls to implement a scriptless solution for creating screens where data is encapsulated in a transaction, but not mapped to a CygNet point. For example, you could make a lift management screen for plungers or other device types in your CygNet environment.

The DDS Edit Box has two purposes, configured via two separate data sources:

  • Get — Retrieve data group transaction data from a remote device, via the DDS Button (using a Get transaction), which is then populated in the DDS Edit Box.
  • Send — Send edited data group transaction data to the remote device, via the DDS Button (using a Send transaction).

The DDS-based controls can be used as a template, meaning they are multiple device-type aware. For example, Device Type A may have a data group called "BasicPoll", but Device Type B may have a similar data group called "Status." In the case where the data group "function" is the same, but the name is different, the controls can handle this difference. The normalization process (handled in other controls via UDC specification) is handled via the Device type specification:

  • The DDS Button control supports configuration of Device type, Data group type, and Ordinal.
  • The DDS Edit Box controls support configuration of Device type, and Data element Id. The display type is assumed to be the DEID Value.
  • The DDS Text Tool controls support configuration of Device type, and Data element Id, and Display type (Value or Description).

Other supported configurable properties include: vertical alignment within the confines of the edit box, a text or label that will display on the edit box, other explanatory text can be displayed (as a gray watermark) when no other text has been entered. The DDS Edit Box shares some properties, events, and methods with the standard Canvas Edit Box control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

DDS Text Tool

DDS

CygNet Aware

 

Supported by TWC

Text Tool icon The DDS Text Tool is DDS-aware control that can be used to get data group transaction data (data group element Ids (DEIDs)) from a remote device for display on a Canvas screen.

By default, data group transaction records are saved only in the DDS for a short time, unless you've mapped one or more data group elements from a data group to UDCs and points for retention in the UIS and historicization in the VHS. Canvas supports three DDS-based controls that can read and write data group transactions:

These DDS-based controls are an efficient way to create transaction-based screens for displaying and manipulating data group information for remote devices. Use these controls to implement a scriptless solution for creating screens where data is encapsulated in a transaction, but not mapped to a CygNet point. For example, you could make a lift management screen for plungers or other device types in your CygNet environment.

The DDS Text Tool displays transaction-based data, and receives its source facility and data group information from a DDS Button. The user then configures its transactional elements for display: the device type, data element ID (DEID) and the type of element to show in the DDS Text Tool, either the value or the description.

The DDS-based controls can be used as a template, meaning they are multiple device-type aware. For example, Device Type A may have a data group called "BasicPoll", but Device Type B may have a similar data group called "Status." In the case where the data group "function" is the same, but the name is different, the controls can handle this difference. The normalization process (handled in other controls via UDC specification) is handled via the Device type specification:

  • The DDS Button control supports configuration of Device type, Data group type, and Ordinal.
  • The DDS Edit Box controls support configuration of Device type, and Data element Id. The display type is assumed to be the DEID Value.
  • The DDS Text Tool controls support configuration of Device type, and Data element Id, and Display type (Value or Description).

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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Font sizing, text alignment, trimming, wrapping, styling, and 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.

The DDS Text Tool shares many properties, events, and methods with the standard Canvas Text Tool control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Detail

Data Visualization

CygNet Aware

Single Value

Supported by TWC

Detail icon 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 Not supported by TWC
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.

Donut

Data Visualization

CygNet Aware

Single Value

Supported by TWC

Donut icon The Donut is a CygNet-aware single-value control that displays real-time point data on a circular linear scale. Data is represented in a ring that fills the Donut in a clock-wise direction to a 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 attribute of the associated point (using an Indexed field, General data field, Minimum setpoint value (analog only) or Maximum setpoint value (analog only)). A Donut 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.

Several other configurable properties are supported, including:

  • A configurable value marker is displayed on the Donut to indicate the point value.
  • A second inner ring is supported to show alarm ranges that correspond to the alarm setpoints for the associated point.
  • A Donut can optionally be labeled with three tokenized text strings.
  • 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.
  • 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 alarm limit range can optionally be configured to display point state color.
  • Colors displayed 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 optionally can be hidden if the associated point tag is invalid.
  • The ring or bar optionally can be hidden if any misconfiguration in the value bounds settings is detected and an "Invalid bounds" label will be displayed on the control.
  • 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.

Dynagraph

Data Visualization

CygNet Aware

 

Supported by TWC

Dynagraph icon The Dynagraph control is used to view dynagraph card data to provide a window into rod-pump well performance by displaying cards for available Pump Off Control (POC) facilities in your CygNet system. You can remotely monitor and control surface and downhole stroke position and load, configure pumpoff conditions, and analyze status data from your Canvas screens. The control displays cards from POC facilities that support the necessary data groups, as dynagraph card display is dependent on downhole calculation. Downhole calculation requires well specification and proper configuration in the DDS via the Downhole Configuration data group for the associated remote device.

The control contains a card plot area displaying selected dynagraph card(s) (Surface, Downhole, or Both), to graphically illustrate load versus position data. Load (in pounds) is plotted on the vertical axis; position (in inches) is plotted on the horizontal axis. Although only one card type can be selected at a time, it is possible to select a set of cards to overlay in the card plot area. The POC (Pumpoff Condition) setpoint is displayed as a point within the stroke curve on the surface card. When the curve deviates such that the point is outside of it, a pumpoff condition occurs.

The Dynagraph control can be configured to receive its POC facility data from the screen or another Canvas control, such as a Tag Chooser, or it can be explicitly configured. The control includes an optional run-mode context menu that supports communication with devices to retrieve card data, and retrieve and edit pumpoff configuration data and fluid fill setpoint data.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Edit Box

Common

 

 

 

Not supported by TWC

Edit Box icon The Edit Box can be added to a screen to allow single- or multi-line user input. Its purpose is to take user input, which can be retrieved via script using the Text property. The input could be used in a variety of ways. One of the most common implementations is to specify the value for a setpoint command; for example, to enter a maintenance date. Explanatory text can be displayed (as a gray watermark) when no other text has been entered. Script events are available to support action when any key on the keyboard is pressed or released while the Edit Box has focus. Script is required to facilitate user interaction with an Edit Box object.

Facility Emitter

Common

CygNet Aware

 

Supported by TWC

Facility Emitter icon The Facility Emitter is a special CygNet-aware control that leverages the facility receiving and sending model in Canvas allowing multi-directional linking between controls. With this control you can deliver sophisticated screens without script. The control takes facility information passed to it from a sending control (e.g., a tag chooser, map, or even a grid), applies a facility filter, then delivers filtered data to other receiving controls on the screen. The Facility Emitter is a hidden control, visible only in design mode.

The Facility Emitter allows for the creation of easy-to-maintain, no code Canvas screens; and it:

  • can be connected to any sender control to receive its facility context
  • can be connected to any receiving control to send filtered data
  • can be connected to another Facility Emitter in a daisy-chain to allow deeper filtering before passing data to a final receiving control
  • supports relative facilities and generic filtering to deliver any kind of data to the receiving control
  • supports a label so you can identify multiple Facility Emitter controls on a screen in design mode.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Heat Map

Data Visualization

CygNet Aware

 

 

Not supported by TWC

Heat Map icon The Heat Map is a CygNet-aware tool that can be used to display historical CygNet data in a two-dimensional representation in which data values are represented by a range of configurable colors. Its purpose is to visualize data in colored rectangular cells where the color of each cell represents the cell's value and makes it easy to compare all data values. Several other configuration properties are supported, including: configurable date ranges, both relative and absolute; historical rollup values; background, low range color, and high range color; visible color scale; cell padding, labels, and tooltips; visible top labels, and row height.

Image

Common

CygNet Aware

Single Value

Supported by TWC

Image icon The Image control is a CygNet-aware single-value control that can be used to display raster (bitmap) and vector images on your screens. Supported image file formats include bitmap (.bmp), portable network graphics (.png), jpeg (.jpg and .jpeg), graphics interchange format (.gif) and scalable vector graphics (.svg). Canvas does not support animated .gifs, or animated .svgs. The control can display a static image or a CygNet-aware image or icon, which can be configured to change based on the point state or alarm condition of the associated point. The Image control will be hidden if the configured point is in a point state that doesn’t match any configured images for the control. The control will then update to display the configured image if the point enters a state matching the point scheme, point type, and point state. If no default or custom point state image is specified, a missing image icon (Missing image icon) is displayed at design and run mode. The size of the image can be set independently from the size of the control, so that a smaller image can be displayed in a nominal case and a larger, different image in the case of an alarm. Several other configurable properties are supported, including:

  • The control can be configured with a valid point configuration but prevented from retrieving any CygNet data, allowing the display of static text while still allowing CygNet data context available from script.
  • Date, time, and value formatting for the text displayed on the control is supported.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.
  • 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.
  • The control optionally can be hidden if the associated point tag is invalid.
  • 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.

Linear Gauge (Horizontal)

Linear Gauge (Vertical)

Data Visualization

CygNet Aware

Single Value

Supported by TWC

Linear Gauge Horizontal icon Linear Gauge Vertical icon The two Linear Gauge controls are CygNet-aware single-value controls that 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 attribute of the associated point (using an Indexed field, General data field, Minimum setpoint value (analog only) or Maximum setpoint value (analog only)). A gauge 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. Several other configurable properties are supported, including:

  • 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 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.
  • 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.
  • Colors displayed 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 optionally can be hidden if the associated point tag is invalid.
  • The ring or bar optionally can be hidden if any misconfiguration in the value bounds settings is detected and an "Invalid bounds" label will be displayed on the control.
  • 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.

Map

Navigation

CygNet Aware

 

Supported by TWC

Map icon The Map control is a CygNet-aware tool that can be used to give geographical context to your facility data. The map supports multiple map layers, which can be used to display CygNet facility location data via three types of visual items, which represent what will be displayed for the facility at the specified coordinate, including:

  • Image — an image or an icon, for example, an oil droplet image shown at a well site
  • Shape — a customized geometric shape, for example, a diamond showing information about the facility Not supported by TWC
  • Object — a Canvas object containing, for example, a Donut or Linear Gauge showing information about the facility Not supported by TWC

Some preconfiguration is required in the Facility service to store a facility's latitude and longitude location coordinates in facility attributes.

Map settings must be configured in the Backstage view and include the map provider (for the Canvas Native view the supported map providers are Bing and OpenStreet; for CygNet TWC web view the supported map providers are Azure and OpenStreet), the API key, and the facility attributes used to store the location data. These values are stored in the Canvas global settings file.

The Map requires Internet connectivity on the computer where Canvas or CygNet Thin Web Client is viewed to access the map providers.

Other configurable properties include the map units, map mode, zoom level, and the map's center when first displayed. The facility source for each map layer can be explicitly configured and filtered, or received from the screen. A specific map layer can act as a facility sender, which can be designated as the facility source on any other control configured to receive it. Whenever the visible items are updated (via pan, zoom, etc.) the dependent control’s facilities are updated accordingly. A specific map layer can act as a facility receiver, so the layer can receiver its facility information from another control on the screen. The map supports hyperlinking to other screens from an image or a shape via configuration or scripting. A single click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), and Replace. The map supports the ability to show or hide different visual items (images, shapes, or objects) on a map layer at different zoom levels, so that visual items can change as you zoom in and out of the map. Other run-mode features include a map view control, a navigation control for panning around the map, a zoom level control, a mini map, mouse position coordinates, and a map scale.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Media Viewer

Common

 

 

 

Not supported by TWC

Media Viewer icon The Media Viewer is a Canvas control that can be used to display videos on your screens. The control supports most widely used video file formats (.mp4, .mov, .wmv, .avi, .flv). The source file path for the video file can be a local or network file-system folder or an APPS or BSS folder. Two playback options are available: Auto, where the video plays continuously in a loop (the user has no control over play and pause functions as those buttons are invisible); or Manual, where playback is handled by play and pause buttons. A slider is always visible in run mode to move the video forwards and backwards. The Media Viewer also supports a configurable border color around the video and controls.

Navigation Button

Common

CygNet Aware

Single Value

Supported by TWC

Navigation Button icon The Navigation Button is a CygNet-aware single-value control that can be used to add buttons to your screens that implement hyperlinking to other Canvas screens without scripting. Several other configurable properties are supported, including:

  • This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close.
  • 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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Alarm indication (blinking) is supported for the button's background, text, and border when the associated point is in alarm.
  • 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.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.
  • 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.
  • Buttons also support the addition of an image.
  • 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.

The button shares many properties, events, and methods with the standard Canvas Button control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Navigator

Navigation

 

 

 

Not supported by TWC

Navigator icon The Navigator control is a navigation control that can be populated to display any number of Canvas screens and objects. Intrinsic to the control is a hierarchical menu on the left side, which can be configured to organize access to different categories of information. The navigation menu supports a single nested level of navigation; that is, you can configure multiple top-level menu items, each containing multiple sub-menu items. When a menu or sub-menu item is clicked a related screen will be displayed in the body of the control. The path to the linked screen can be an APPS or BSS folder or a local or network file-system folder. Additionally, each menu item can display a configurable icon to the left of the menu's label. The navigation menu includes an adaptive display mode designed to preserve screen real estate: it can be configured to minimize all menu items, display only the top-level menu icon, or display the icon and menu item label. See the Tab control for a lighter version of the navigator.

Nested View

View

CygNet Aware

 

Supported by TWC

Nested View icon The Nested View is a CygNet-aware container that shows another screen, meaning you can show a screen within another screen. This allows for more templated screens or dynamic screens, which can be swapped out at runtime based on user selection. You can add as many Nested Views as you want to a single screen; you can also nest as many screens as you want within a Nested View – there is no limit to the number of levels within each Nested View.

Note: In the Canvas Native view you can referenced a CygNet Studio screen (.csf) in a Nested View control, although the screen must be tabbed to display correctly. CygNet Studio screens (.csf) are not supported in a Nested View in the CygNet TWC web view.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Note Grid

Grid

CygNet Aware

 

Supported by TWC

Note Grid icon The Note Grid is a special type of grid that supports the read-only display of CygNet notes, allowing users to view annotations and share information relevant to production system activities and events. CygNet notes are stored in the CygNet Note service (NOTE), and managed using an interface that provides a way to record a message, define the point in time or time range to which the message relates, categorize the note by type, and apply custom attributes. Each note can be associated with one or more facilities and points. If a note has one or more associated facility or point, the Note Grid will add a row for each association and show a single association per row. When the Note Grid receives its facilities from another control, the grid will only show notes for received associated facilities. The Note Grid supports two column types: Facility and Note. Facility columns are mapped to a facility attribute and can resolve to a relative facility. Note columns display annotations stored in the NOTE service by attribute, between a range of dates, and can be filtered by note type. The date and time of notes displayed in the grid can be changed in run mode and grid data can be exported to a .csv file in run mode. Other configurable properties are supported, including:

  • The facility and SiteService are configured for the grid row and each can be explicitly set (and filtered) or sourced from other another control or the screen.
  • The grid can be configured as a facility sender, responding differently when a row is clicked. It can send facilities to other controls on the screen.
  • A grid's header background color, header text color, and grid background color can be configured to one of the following options: a) automatically follow the selected application theme regardless of the underlying color palette used, or b) be explicitly configured.
  • The control's color elements can be set to automatically follow the selected application theme regardless of the underlying color palette used or explicitly configured.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Object

Screen

CygNet Aware

 

 

Not supported by TWC

Object icon An Object is a simple Canvas screen containing one or more controls, which can be used on one or many screens. The controls on an object might represent assets such as a well or compressor or device or facility. Once configured, you can drop an object onto many different screens. If you need to make a single edit to any one control on an object, you simply change the master object, save the object, and all screens containing that object will be automatically updated. Any change made to an object will affect all instances of that object on any Canvas screen where it is used. Objects are analogous to templated screens in CygNet Studio. An object and a screen share the same configuration properties, events, and methods.

Object Container

Container

CygNet Aware

 

 

Not supported by TWC

Object Container icon The Object Container is a CygNet-aware control that dynamically populates itself using Canvas object files (.cob) and passed-in facilities. The control determines how many Canvas objects to draw based on facility inheritance, and then fills itself in with an object for each child of the parent facility. The Object Container allows the creation of sophisticated, easy-to-maintain Canvas screens, it:

  • can be connected to a Tag Chooser or any other facility sender for its facility context
  • supports relative facilities and facility filtering to specify exactly what to display in the container
  • will dynamically resize and re-orient objects appropriately
  • supports a pagination interface to page through objects on multiple pages
  • eliminates the need for complex white-space management scripting.

Object Viewer

 

CygNet Aware

 

 

Not supported by TWC

In design mode a Canvas object is viewed in an Object Viewer control. The Object Viewer's properties are listed in the Properties pane in an Object Viewer control and have the same properties, events, and methods as the Nested View control. You can interact with an Object Viewer control via script in the same way you can with any Canvas control. An Object Viewer control can also have its own styles.

Radio Button

Common

 

 

 

Not supported by TWC

Radio Button icon The Radio Button can be used to add a list of mutually exclusive items; that is, a list from which the user can select only a single item. Script is required to attach commands to the Radio Button, which will be executed when the Radio Button is clicked in run mode. Additionally, you can define a Group name to specify which Radio Buttons are mutually exclusive.

Relative Facility Tree

Navigation

CygNet Aware

 

 

Not supported by TWC

Relative Facility Tree icon The Relative Facility Tree displays a hierarchical tree of CygNet facilities based on the relative facility settings defined for Canvas (configured in the Backstage view, stored in the global settings file). The control takes a source Site.Service, adds a facility filter (if provided), and generates a navigable tree. The control can be used as the primary navigational control on your screens to drive other controls by passing in facilities, allowing the creation and implementation of templated screens.

The idea behind the control is to present a navigation model that closely resembles field operations without the overhead of a group hierarchy. You can build a similar navigation tree with the Tag Chooser using the Group hierarchy type; however, the Relative Facility Tree draws directly from the Facility service to build its tree, without dealing with Group service nodes. Also, you can designate different starting points, for example, a Central Delivery Point (CDP) vs. a Well, without the need to build up different group hierarchies.

Another advantage of this control over the Tag Chooser (with Group hierarchy) is that the Relative Facility Tree control supports three different selection actions:

  1. Simple facility sender to other controls
  2. Navigation by facility to other associated screens by script, hyperlinking, or via the Navigator control
  3. Custom script execution

By designing a set of templated screens for CDPs, Wells, Tank Batteries, Tanks, etc. you can quickly create a powerful workflow using the Relative Facility Tree and an Object Viewer or Navigator control.

Screen

Screen

CygNet Aware

 

Supported by TWC

Screen icon The Screen is where you create flexible and interactive diagrams and layouts for your users. By configuring a screen with controls and tools, you can create a data-rich visualization of devices, facilities, and other elements in your CygNet environment, convey information about the state of a process via charts, grids, gauges, images, and other data-visualization tools, and design workflows where objects are scripted to accept and implement an operator's control instructions in run mode. The Canvas screen is where you create the HMI for your users in the field and is analogous to TheFrame/TheView in CygNet Studio.

Canvas screens and objects share the same configuration properties. Screens (and objects) support a broadcast feature that allows you to manipulate and pass the SiteService and facility from one screen to another using the Canvas user interface without writing script. Screens (and objects) support navigation by facility to link to a facility's associated screen, using one of six navigation modes. Screen hyperlinking is supported via script. Screens and objects support a default or on-demand chart, which can be invoked anytime from a Canvas or Canvas.View screen in design or run mode in the form of a separate dialog box. The default chart supports configurable series type and appearance, flexible date ranges, both relative and absolute; live data updates at a configured interval allowing the chart to trend data at a real-time pace, and historical rollups. Other configurable screen features include: background color, custom color palette for point state, pan zoom control, title, layout grid (color, height, and snap action), and whether the alarm notifier is visible on the screen when opened in Canvas.View and Canvas.View.Lite. A context menu is available in run mode to copy the full screen path, access facility configuration, and show the default chart. Custom context menu items can be scripted allowing customized screen behavior.

Search Box

Navigation

CygNet Aware

 

 

Not supported by TWC

Search icon The Search Box is a powerful CygNet-aware tool for searching facilities or other objects in your CygNet environment. Two search modes are available:

Facility Search

This mode will search all facilities in the specified Facility service and return any matching facility names. Three options are supported when a desired search result is selected:

  1. Facility Sender — the Search Box acts as a facility sender and sends the selected facility to any controls on the screen configured to receive it.
  2. Navigation — the Search Box navigates by facility and links to the selected facility's associated screen. The navigation mode is determined by the Facility navigation mode setting on the screen displaying the Search Box.
  3. Script — an action can be scripted to execute when a facility is selected from the search results.

You can limit the Search Box to execute a search against a Facility service associated with a current value service (CVS), against a custom filter rule, and against a list of facility attributes. The facility attribute values displayed in the search results are configurable. The facilities displayed in the search results are designated with configurable icons. Grayscale icons are available for use with the dark or light color theme:

Icon type Facility - Diamond
Default Facility icon default
Grayscale dark Facility icon grayscale dark
Grayscale light Facility icon grayscale light

Grayscale icons are available for use with the dark or light color theme. See themes for more information.

Custom Search

In this mode the Search Box can be scripted to perform a custom search against any object, for example, a SQL database, a .csv file, even a website. Further custom actions can be executed when selecting an item in the search results.

SetPoint Button

Common

CygNet Aware

Single Value

Supported by TWC

SetPoint Button icon The SetPoint Button is a CygNet-aware single-value control that can be used to add buttons to your screens that perform a setpoint command to change to a new point value without scripting. The button allows the screen designer to configure a small dialog box that prompts a user to enter a new point value. The dialog box’s title and instructional message are configurable via tokenized values and static text. The point’s current value, primary units and timestamp are included on the dialog box for reference. 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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Alarm indication (blinking) is supported for the button's background, text, and border when the associated point is in alarm.
  • 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.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.
  • 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.
  • Buttons also support the addition of an image.
  • 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.

The button shares many properties, events, and methods with the standard Canvas Button control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Shape

Common

CygNet Aware

Single Value

Supported by TWC

Shape icon The Shape control is a CygNet-aware single-value control that supports the drawing of geometric shapes, such as ellipses, triangles, rectangles, polygons, lines, lines with arrowheads, and other custom paths on your screens. You can use one of several predefined shapes or line types or specify a geometric syntax to draw a custom path or line style. 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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • 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.
  • The control can be configured with a valid point configuration but prevented from retrieving any CygNet data, allowing the display of static text while still allowing CygNet data context available from script.
  • The control optionally can be hidden if the associated point tag is invalid.
  • Date, time, and value formatting for the text displayed on the control is supported.
  • Font sizing, text styling, and text weighting are also configurable.
  • This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close.

  • 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.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Sparkline

Chart

CygNet Aware

Single Value

Supported by TWC

Sparkline icon The Sparkline chart is a CygNet-aware single-value control that displays historical data for a single point on a single line. This lightweight line chart is drawn without axes, labels, or legend, and is typically used to understand the shape of historical data: trends up or down, highlight maximum or minimum values, and identify spikes in the data. A Sparkline supports configurable line and background color, configurable x-axis and y-axis, configurable date ranges, both relative and absolute, and live data updates to allow the Sparkline to request new data at a configured interval giving the appearance that the Sparkline is trending data at a real-time pace.

A Sparkline can be added to other controls, including: a CygNet Grid, a Detail control, and a Tile View control.

Tab Control

Navigation

 

 

 

Not supported by TWC

Tab Control icon The Tab control is a navigation tool that incorporates a collection of tabs across the top of the control and an optional Nested View linked to associated content. The tabs allow you to easily switch between different Canvas screens and objects within a single container. The path to the linked screen can be an APPS or BSS folder or a local or network file-system folder (Not supported by TWC). The Nested View is only visible if a screen path is configured for that particular tab. The Tab control is a lighter version of the Navigator.

Tag Chooser

Navigation

CygNet Aware

 

Supported by TWC

Tag Chooser icon The Tag Chooser displays a hierarchical tree of CygNet facilities and points, allowing the creation and implementation of templated screens in Canvas. It can be used as the primary navigational control on your screens to drive other controls by sending facilities and point values to receiving controls. The Tag Chooser supports both facility and point resolution. Point resolution is optional at the facility level and can be turned off or on simply by selecting the Show points check box at design time. You can specify which UDCs to hide when showing points in the hierarchy tree.

Hierarchy Type

The Tag Chooser offers two types of hierarchical configuration: by Facility service attributes, or by Group service nodes:

  • Facility service attributes — This type of hierarchical configuration uses facility attributes, such as text-based or table-based attribute (which are determined by global attributes configured in the CygNet Facility service) to group individual facilities into a hierarchy. Generally, facility attributes that represent individual facilities, such as Facility ID and Facility Description, are used as the leaf node in the hierarchy—the last level. However, other facility attributes that may contain multiple facilities, such as Field or Area, can also be used as the leaf node in a hierarchy. You can further limit the Tag Chooser by any CygNet filter attribute set up for your system.
  • Group service nodes — This type of hierarchical configuration uses the nodes configured in your CygNet Group service to organize groups into a hierarchy. You can further filter the Tag Chooser by a facility type. This filter must use a valid facility type in your system.

The facilities and points displayed in the Tag Chooser hierarchy are designated with configurable grayscale icons for use with the dark or light color theme. See themes for more information.

Collapsible Tag Chooser

The Tag Chooser is also supports a collapsible mode in Canvas native and web view environments. This is especially useful for screens viewed in the CygNet Thin Web Client on a smaller form-factor device such as a mobile phone or tablet allowing you to collapse and hide the navigation hierarchy and reclaim valuable screen real estate. In collapsible mode a selected node will be sent to any receiving control(s), the node name will be displayed in header row above the Tag Chooser, and the Tag Chooser will collapse and automatically close when "Auto close" is selected.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Text Tool

Common

CygNet Aware

Single Value

Supported by TWC

Text Tool icon The Text Tool is a CygNet-aware single-value control that can be used to display text on your Canvas screens. 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. Several other configurable properties are supported, including:

  • The control can be configured with a valid point configuration but prevented from retrieving any CygNet data, allowing the display of static text while still allowing CygNet data context available from script.
  • 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. Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Alarm indication (blinking) is supported for the control's text, background, and border when the associated point is in alarm.
  • The control optionally can be hidden if the associated point tag is invalid.
  • Date, time, and value formatting for the text displayed on the control is supported.
  • Font sizing, text alignment, trimming, wrapping, styling, and weighting are also configurable.
  • This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close.
  • 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.

Tile View

Container

CygNet Aware

 

 

Not supported by TWC

Tile View icon The Tile View is a CygNet-aware container that displays real-time data in a series of tiled Detail controls, one for each facility provided. The Tile View determines how many Detail tiles to draw based on facility inheritance, and then fills itself in with a tile for each child of the parent facility, adjusting layout accordingly. The Tile View allows you to build screens in a dynamic way with little maintenance, and easily add new points or facilities to a screen without additional scripting. Each Detail tile in a Tile View displays 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 configurable line color, x- and y-axis, date ranges, both relative and absolute, and live data updates
  6. an arrow that is scripted to flip the Detail control when clicked and display an object of your choosing on the reverse side of the Detail control. The object on the reverse side will receive its point configuration from the Detail control.

The last three elements (alarm icon, sparkline, and flip icon) can be toggled on or off. 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. The Tile View has two display modes for its tiles:

  • Single UDC — Where data for a single UDC is displayed and a tile will be created for each child of a parent facility
  • Each UDC for Facility — Where facilities are queried for their associated UDCs and a tile will be created for each one

Additionally, each tile in the Tile View includes a title bar showing the facility name and a maximize button. When clicked in run mode the tile will maximize and open a screen, object, or CygNet Studio screen populated with related data for the passed-in facility from the originating tile. The maximized screen or object can be minimized to return to the initial Tile View. Each tile displays a context menu 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.

Tree Map

Data Visualization

CygNet Aware

 

 

Not supported by TWC

Tree Map icon The Tree Map is a CygNet-aware tool that can be used to display historical or real-time data as a set of relatively-sized and colored rectangles. Each rectangle has an area proportional to its numerical value. Several other configuration properties are supported, including: configurable date ranges, both relative and absolute; background, low range color, and high range color; display mode (best fit or vertically stacked); filtering to show only top or bottom items; and historical rollup values.

UIS Command Button

Common

CygNet Aware

Single Value

Supported by TWC

UIS Command Button icon The UIS Command Button is a CygNet-aware single-value control that can be used to add buttons to your screens that send any kind of UIS command for a specified facility without scripting. Supported properties include the name of the command as defined in the DDS and the command's parameters and values, which can be pre-defined in the button or the button can be configured to prompt the user for a parameter value. Additional support includes a status point UDC to monitor the status of the UIS command, an option to enable or disable the button while the command is in progress, and support to prompt a user for confirmation to send the command. The Canvas version of this control is similar to the UIS Command Button in CygNet Studio. 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.
  • Colors displayed in the control can be overridden when a custom color palette is selected for the screen.
  • Alarm indication (blinking) is supported for the button's background, text, and border when the associated point is in alarm.
  • 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.
  • The mouse cursor that appears when the mouse hovers over the control is configurable.
  • 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.
  • Buttons also support the addition of an image.
  • 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.

The button shares many properties, events, and methods with the standard Canvas Button control.

This control is supported in the Canvas Native view and the CygNet TWC web view.

Value Indicator

Data Visualization

CygNet Aware

Single Value

Supported by TWC

Value Indicator icon The Value Indicator is a CygNet-aware single-value control that adds visual context to real-time point and alarm data. A data range is represented on a vertical bar that fills the control between an upper and lower 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 attribute of the associated point (using an Indexed field, General data field, Minimum setpoint value (analog only) or Maximum setpoint value (analog only)). A Value Indicator 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. Any configured alarm limits for the associated point are indicated on the bar and an animated marker on the left side points to the current value. Several other configurable properties are supported, including:

  • 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.
  • 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 alarm limit range can optionally be configured to display point state color.
  • Colors displayed 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 optionally can be hidden if the associated point tag is invalid.
  • The ring or bar optionally can be hidden if any misconfiguration in the value bounds settings is detected and an "Invalid bounds" label will be displayed on the control.
  • 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.

Well Test Control

Well Test

CygNet Aware

 

 

Not supported by TWC

The Well Test Control (CygNet.API.WellTest.Controls.dll) is a special plugin control assembly that is available for use in Canvas to allow the manual definition of the well test configuration XML file. This plugin provides a user-friendly method for defining the necessary elements required to execute a well test via a Canvas screen. Using the control assembly and a configuration screen you can easily define the following well test properties: Point Scheme, data retention value, relative facilities, UDCs, headers, wells in the well test, header templates, positions, commands, and associated actions for each command.

Additional Resources

For more information about using Canvas to configure and use the CygNet Well Test module, see Well Test and Well Test Control.

Related Topics