The Accepts return check box indicates that the edit box will accept the return key to create a new line in the text block in run mode.

The Alarm attribute property specifies the alarm attribute that will be displayed in the column. Click to reveal a drop-down menu of available CygNet alarm attributes supported by the alarm grid:

• Alarm Condition
• Set / Reset State
• Alarm Hidden
• Alarm Suppression State
• Point State
• Reported Time
• Alarm Priority Highest
• Alarm Priority Highest Since Ack
• Alarm Priority Highest Category
• Alarm Priority Highest Category Desc.
• Alarm Priority Highest Since Ack Cat.
• Alarm Priority Highest Since Ack Cat. Desc.
• Facility Tag (CAS)
• Alarm Priority
• Primary Value
• Secondary Value
• Alarm Acknowledgment Status

An alarm column presents data for a point by an alarm attribute.

The Alarm filter property is used to limit the data that is presented in the alarm grid by configuring alarm filtering rules. Click to open the Alarm Filter dialog box, where you can create a custom alarm filter rule. The filter rule is displayed in the property label; you do need to open the Alarm Filter dialog box to edit the rule.

The Alarm icon column property is used to indicate whether a column and icon will be displayed as the first column of the alarm grid. A customizable icon can be configured to change color based on point state and change image based on alarm priority. Icons will display only when there is an unacknowledged alarm. Click to configure the column, the icon color source, the associated priority ranges, and the icon image used for each priority in the Alarm Priority Icon Ranges dialog box.

The Alarm icon configuration property is used to configure the alarm icon that can optionally be included in the upper right corner of the detail control. If enabled in the Show alarm icon property, a customizable icon can be configured to change color based on point state and change image based on alarm priority. Icons will display only when there is an unacknowledged alarm.

Click to configure the icon color source, the associated priority ranges, and the icon image used for each priority in the Configure Alarm Icons dialog box.

The Animate Marker check box indicates whether to animate the marker movement. When enabled the Value Indicator's marker will move smoothly from one value to the next value.

The Appearance property group contains properties that configure the appearance of points on the chart series, such as enabling points, color, point size, enabling labels, and label colors.

The Arrow size property specifies the size of the arrowheads at the end of the line shapes. Select a number using the spin control. The default value is 20. The Shape type must be one of the arrow shapes to take effect.

The Auto range x-axis check box indicates whether the sparkline's x-axis is constrained to the range of values for the associated point or fixed to the configured time range (default). Configure the date and time range in the Range properties below.

The Auto range y-axis check box indicates whether the sparkline's y-axis is constrained to the range of values for the associated points (default) or fixed to the configured minimum and maximum values. Configure the y-axis scale in the Maximum Y value and Minimum Y value below.

The Background color property specifies the color used for the background of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is BackgroundColor.

Options include:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the color used for the background of the grid cell.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal two options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the color used for the background of the control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the background color of the screen, object, or control. Click to customize the color using the color picker.

Combo Box —

The Background color property specifies the background color of the combo box header. Click to customize the color using the color picker.

The Background color source property specifies the color source for the background color of the screen, object, or control. Two options are available:

• Auto — Overrides the background color with a theme-appropriate color (default). Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
• <Self> — The color selected in the Background color property will be used.

The default option is Auto.

The Bar color property specifies the color used for the bar that represents the point value in the linear gauge control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Base node property specifies the group node to use as the base (or bottom) of the hierarchy. Click to select the desired node from the Select Group Hierarchy Node dialog box. Note that you must set up a group hierarchical structure with levels of nodes in your CygNet system prior to selecting a base node in the tag chooser.

The Begin date or Start or Start date property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

Tree Map —

The Begin date property specifies the start date and time to use when rolling up historical data. Data between the Begin relative date and the Begin date will be rolled up and displayed in the tree map. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to a screen. Click to change the date using the date picker.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

Tree Map —

The Begin relative date property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

See Display alarm acknowledgment

The Border color property specifies the color used for the border of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is Auto.

Options include:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Border color property specifies the color used for the border of the grid cell.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal two options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Border color property specifies the color used for the border of the control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Border width property specifies the width of the text tool's border.

The Bottom information text property specifies the text that will appear on the bottom information area on the control, which can be a static 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. Click to configure text and property strings using the CygNet Property String dialog box. The default value is the %Units% token.

The Broadcast facilities check box indicates whether to notify other screens when this screen's facility selection changes. When enabled, and when a screen's facility selection changes, Canvas will broadcast the list of facilities out to all other screens open in the application that are configured to source their facility from <Broadcast>.

The Broadcast SiteService check box indicates whether to notify other screens when this screen's SiteService selection changes. When enabled, and when a screen's SiteService selection changes, Canvas will broadcast the SiteService out to all other screens open in the application that are configured to source their SiteService from <Broadcast>.

The Cell padding property specifies the size of the padding around each heat map cell in pixels.

The Chart drop mode property specifies how the chart should handle the facility from a dropped point. Two options are available:

• Use dropped facility — Create a series using the full point tag, including the facility tag from the point dropped on the chart (default).
• Use control facility — Create a series using the UDC from the dropped point but drive the facility tag at the control level.

The default value is Use dropped facility.

The Checked property indicates whether the check box initially displays as checked.

The Color property specifies the color of the point in the chart series. The Show points property must be enabled to change the point color. Click to customize the color using the color picker.

The Sparkline color (or Color) property specifies the color of the sparkline. Click to customize the color using the color picker.

The Color property specifies the color of the chart series. Click to customize the color using the color picker.

The Color configuration box contains all the options required to specify the color properties of the control. Click to reveal a set of color options where you can specify the source of the color to be used for the elements of the control. The Color configuration box consists of the following options.

See each control for more information about configuring color properties.

The Color palette property specifies the color palette to use for the CygNet-aware controls on this screen. Select the desired palette from the drop-down menu. Select None to use the default CygNet point state colors. This is the default value.

See Configuring Color Palettes for more information.

Alarm Grid —

The Grid Column Configuration dialog box contains all properties required to configure columns in your grid. There are five types of columns that can be configured in an alarm grid: an Alarm icon column (configured separately), an Alarm column, a Facility column, a Generic column, and a Point column. The number of defined columns is listed on the property label once defined.

You can create your own columns or select from 11 default columns: four Alarm columns (Alarm Priority, Alarm Acknowledge, Primary Value, Timestamp), and seven Point columns (Alarm Condition, SiteService, Long Point ID, Primary Units, Description, Facility ID, Uniform Data Code).

Click to open Grid Column Configuration dialog box.

CygNet Grid —

The Grid Column Configuration dialog box contains the properties required to configure each column in your grid. There are four types of columns that can be configured in a CygNet grid: a Facility column, a Generic column, a History column, and a Point column. The number of defined columns is listed on the property label once all are configured.

Click to open Grid Column Configuration dialog box.

The Configuration drop-down box contains the properties required to configure the tag chooser using a Facility hierarchy: a Facility service, an optional Facility filter, and the facility attribute hierarchy levels.

The Configuration drop-down box contains the properties required to configure the tag chooser using Group service node hierarchy: a Group service, Base node, and the Facility type filter.

The Custom Context Menu Configuration dialog box is where you configure any custom context menu items that will appear in the right-click context menu for the screen or control. Each custom context menu item will call an event into script so that you can customize screen or control behavior.

The custom context menu options will appear at the bottom of the fixed context menu options, separated by a line.

Each custom context menu item has a title and an event script ID; items can be designated as a separator; and custom context menus support nested menu items.

Click to open the Custom Context Menu Configuration dialog box.

The Control margin property specifies the size of the whitespace between displayed objects in pixels.

The Custom line style property specifies a special abbreviated syntax that defines the line's pattern. If you want to manually modify these values, set the Line style type to Custom. For example, 1 3 1 renders a dot-dash-dot effect.

The CygNet connection property is used to configure the facility and SiteService associated with this control or screen. Two selection modes are available: a) by Facility tag or b) by SiteService / Facility. This split configuration allows for the inheritance of these properties from other controls, or the specific configuration of the SiteService or the facility, while dynamically changing the other. This use case may be rare; therefore, the Facility tag option is the default.

Click to reveal a drop-down area where you can configure the Selection mode, source SiteService, and source Facility. Each option is described below.

See each control for more information about configuring the CygNetconnection.

Chart —

The Data source property specifies the source of the data used in a selected series. The options are as follows:

• CygNet — The series will display native CygNet data. This is the default value.
• Script — The series will display non-CygNet data from a custom script. For example, you might display data with a generic SQL query from an external database. See Scripting a Chart Series for more information and examples.

The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to a point's Timestamp, Last Verified Change Timestamp, and Last Questionable Change Timestamp properties. Use this property to override the default format, which is configured on the Settings page of the Backstage view. The default format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2019/01/01 10:20:30.0001. All timestamps are local client time.

The Date range configuration property is used to configure the range of dates to be trended in the chart or sparkline, whether to enable live data updates, the live update rate, the starting time for a trend, whether to use relative or absolute dates, and the actual date range. Click to open the Configure Time Range dialog box, where you can configure these properties.

You can change the date and time range settings for any chart in run mode via an icon on the chart toolbar.

The Default chart file property specifies the path to the chart file associated with this screen.

• Click to access the Open dialog box and select either the BSS or Local.
• Click BSS to access a CygNet APPS or BSS folder.
  • Browse to the folder and file you want to open.
• Click Local to access a local or network Windows file-system folder.
  • Browse to the folder and file you want to open.
• Click OK to save the file path.
• Or click Cancel to abort and close the Open dialog box.

This property specifies the source to the file, image, object file, or screen. Options include:

• BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
• Local — Indicates that the file is stored in a local or network Windows file-system folder

The default file source is Local.

The Default to first item check box indicates whether the first item configured will be the default selected item when starting a screen, instead of showing the Watermark.

Chart —

The Delay loading property indicates whether to delay data loading for the chart. Use this to stop unwanted messaging to the service, for example, if you don't want the chart to load when the screen first opens. This is necessary when using scripted data sources for a series, to give the script time to set the delegates before data retrieval begins.

Relative Facility Tree —

The Delay loading property indicates whether to delay data loading for the control. Use this to stop unwanted messaging to the service, for example, if you don't want the control to load when the screen first opens. You can turn off the DelayLoading flag via script, then use Refresh to trigger data loading after the delay.

Tag Chooser —

The Delay loading property indicates whether to delay data loading for the control. Use this to stop unwanted messaging to the service, for example, if you don't want the control to load when the screen first opens. You can turn off the DelayLoading flag via script, then use RefreshTagChooser to trigger data loading after the delay.

Alarm Grid, CygNet Grid, Text Tool —

The Display alarm acknowledgment property enables the cell or text tool's background, text, and border to blink when the associated point is in alarm. Check each box to configure the:

• Background — The background of the cell or text tool will blink when the associated point is in alarm.
• Text — The text in the cell or text tool will blink when the associated point is in alarm.
• Border — The border of the cell or text tool will blink when the associated point is in alarm.

If none of these options are selected, no visual indication of a point in alarm will be presented. However, if the point is in alarm, an Acknowledge alarm option will be available from the context menu in run mode.

Button —

The Display alarm acknowledgment property enables the button's text and border to blink when the associated point is in alarm. Check each box to configure the:

• Text — The text on the button will blink when the associated point is in alarm
• Border — The border of the button will blink when the associated point is in alarm

If none of these options are selected, no visual indication of a point in alarm will be presented. However, if the point is in alarm, an Acknowledge alarm option will be available from the context menu in run mode.

The Display alarm ranges check box indicates whether to display alarm ranges for the setpoints for the associated point on the donut. The colors depicted for the ranges are randomly chosen from a predefined set of colors.

The Display mode property specifies how to display the navigation menu when the screen is in run mode. By default, the navigation menu and the control's contents will adapt depending on the amount of available space. Options include:

• Minimal — The navigation menu shows and hides as you click the navigator icon () and all menu items are hidden when clicked
• Compact — Only the top-level menu icons display and sub-menu items are hidden when clicked
• Expanded — The top-level menu items always on display and sub-menu items are hidden when clicked

The default value is Compact.

The Display mode property specifies the method for displaying the data elements in the tile view. Options include:

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

The default value is Single UDC.

The Display mode property specifies the method for displaying the data elements in the tree map. Options include:

• Best fit — Elements are sized based on value and arranged in rectangles to best fit within the control's space. Best fit is the default value.
• Stacked — Elements are sized based on value and stacked vertically to fit within the control's space.

The default value is Best fit.

The Drag mode property determines the drag action for the chart in run mode. Setting it to Pan will start panning, instead of zooming when you drag the mouse over the plot area. To forbid any drag actions you can set the Drag mode to None. Options include:

• None — Turn off all dragging actions. Neither panning nor zooming is enabled.
• Pan — Enable panning only, zooming is disabled.
• Zoom — Enable zooming only, panning is disabled.

The default value is None.

The Earliest (span) property specifies the starting date for a trend; that is, the amount of time in the past from when to start the trend. Enter a number in the text box and select a time period from the drop-down menu. For example, 8 Hours ago or 2 Days ago.

The Earliest (unit) property specifies the unit of time in the past from when to start the trend. After entering a number in the text box, select a time period from the drop-down menu. The options include: Seconds, Minutes, Hours, Days, and Years. For example, 60 Seconds ago or 2 Hours ago. The default value is Hours.

The Empty bar color property specifies the color used for the empty or inner background bar in the linear gauge control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Empty ring color property specifies the color used for the empty or unused ring in the donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Enable live updates check box indicates whether this chart or sparkline will request new data at a specified interval allowing the chart to trend data at a real-time pace. When live updates are enabled and the next poll occurs, the series line will update to reflect the slope change, if any. The interval at which the trend moves forward is defined in the Update rate. If disabled, a trend is populated once with data from the Value History Service (VHS). You can disable/enable live updates for any chart in run mode via an icon on the chart toolbar.

See Live Update Changed for related event.

The Enabled check box indicates whether the control is enabled. The default value is True. When set to False, the control is visible in run mode, but grayed out and disabled from use.

Image —

The Enabled check box indicates whether the image on the control is enabled. The default value is True.

The End date or End property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The End relative date or Relative end date or End property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Facility property specifies the facility for which the control (or screen) is to display data. Click to select a facility using the Select Facility dialog box.

The Facility property specifies the source facility for the CygNet grid's rows. Options include:

• Source — Options include <Self>, Screen (default), or a list of Sender controls.
  • <Self> — Select <Self> to explicitly configure the facility for this control, which can be further filtered,.
  • Screen — Select Screen to inherit the facility from the screen for this control. By default, the sender is the Screen control if no other senders have been configured. Once Screen is selected Inherited from Screen will display for the Facility property.
  • Sender — A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.
• Filter — Only visible is the Source is <Self>.

  Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

The Facility attribute property specifies the facility attribute that will displayed in the column. Click to reveal a drop-down menu of all available CygNet facility attributes categorized by type:

• Facility: General Attributes (The default value is Facility Description.)
• Facility: Text Attributes
• Facility: Table-driven Attributes
• Facility: Yes/No Attributes

Click to expand each category and select the desired facility attribute.

A facility column presents data for a point by a facility attribute. You can choose to resolve the facility to a relative facility if desired.

CygNet Grid —

The Facility filter option is visible only if the Facility Source is <Self>.

Use the Facility filter property to limit the data presented in the control (or row or layer) to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

Object Container, Relative Facility Tree, Tag Chooser —

Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

Search Box —

Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. A search will be executed against the facilities that are described by this filter. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

The Facility mode property specifies how to handle facilities provided to the object container. Options include:

• Facility list — The object container will use the facilities provided and make an object for each one.
• Resolve children — The object container will use the Facility filter to resolve the children of the provided facility and create an object for each one.

The default value is Resolve children.

The Facility navigation mode (FacilityNavigationMode) property is included on the screen object to determine how a screen will handle a request to navigate to another screen via a facility. This property is used with the NavigateByFacility or OpenedViaHyperlink events to link to a facility's associated screen or replace a current screen in a Navigator control with a facility's associated screen. Click to reveal a drop-down menu of options:

• Script event —

  Fires a NavigateByFacility script event on the screen that provides the associated screen path, as well as any optional facility record properties, to send when this navigation is triggered. The EventArgs type for this event is:

  Canvas.Shared.Events.NavigateByFacilityEventArgs

  The associated screen path for the facility is configured in the facility record in CygNet Explorer. The screen path facility attribute, and any optional facility record properties to be included when this navigation is triggered, is configured in the Backstage view.

• Hyperlink - Open — Opens the facility's associated screen in a new window.
• Hyperlink - Replace — Replaces the current screen with the facility's associated screen.
• Hyperlink - Replace with navigation — Replaces the current screen with the facility's associated screen and adds a navigation toolbar.
• Navigator - Replace — Notifies any Navigator controls on the current screen to replace the active screen with the facility's associated screen.
• Navigator - Replace with navigation — Notifies any Navigator controls on the current screen to replace the active screen with the facility's associated screen and add a navigation toolbar.

The default value is Hyperlink - Open.

See Navigation by Facility for more information about using this property.

A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.

The Facility sender mode property determines which mouse-click actions will send facilities to other controls. Options include:

• None — No facilities are sent.
• Single click — A single click will send facilities to another control.
• Double click — A double click will send facilities to another control.
• All facilities — All facilities in the grid will be sent to another control.

The default value is None.

Sending and receiving facility tags

Some controls on the same screen allow for the sending of facility tag information from one control to another.

1. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
2. On the receiving control configure the Selection mode property (in either CygNet connection or Point configuration section) to Facility tag and select the Facility Source to the sending control.
3. On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.

The Facility service property specifies the service to use for this tag chooser. Click to select a Facility service using the Select Service dialog box.

The Facility tag property specifies the full facility tag identifier for which the control (or screen) is to display data. Click to select a facility using the Select Facility Tag dialog box.

The Facility type filter property specifies the facility type on which to filter the hierarchy, in all UPPERCASE letters. The nodes in the hierarchy will correspond to the Facility Type column in the Facility service. This must be a valid facility type in your system. The types are stored in the SYSFCTYP table in the Table Reference Service (TRS). You can also see a list of types by displaying the properties for a facility and clicking the Type browse button. For example, common facility types include REMDEV, MTRRUN, WELL, PLNGR, TANKS, PUMP, etc. Leave this blank to include all facility types.

This property specifies the path to the file, image file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Open File dialog box — To access a local or network Windows file-system folder
• Select File dialog box — To access a CygNet APPS or BSS folder

The Fill color property specifies the color used for the internal body of the shape control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Filter Type property allows you to limit the number of facilities displayed in the tree map. By configuring a value in the Items to filter property, and selecting Top or Bottom in this property, only the top or bottom number of facilities will be displayed, no matter how many facilities are sent to the tree map from the sending control. Options include:

• None — No filtering occurs.
• Top — Only show the top number of items in the tree map.
• Bottom — Only show the bottom number of items in the tree map.

The default value is None.

Filtering Values

The tree map will not display a rectangle for negative, zero, and non-numeric values. These unsupported values are converted to a value of 0.0 prior to being added to the tree map, effectively removing them from the control’s display, but not from the underlying data set. If the facilities in a tree map are driven by another control (such as a Tag Chooser or CygNet Grid) the source control will still display the facilities and their unsupported values, even though the facilities will not be displayed in the tree map. This might lead to some confusion when filtering a tree map by Top or Bottom values because the filter will consider all available values, including those that may not be visible in the control.

For example, if a tree map is filtered to show the bottom 5 facilities, and 2 of the facilities have unsupported values, the control will only display 3 facilities.

The Flip enabled property indicates whether to enable flipping of the detail control when clicked.

The Font size property specifies the font size of the text on the control.

The Font size (bottom) property specifies the font size of the bottom text on the control. Only applies if Font size mode is set to Fixed.

The Font size (main) property specifies the font size of the main text on the control. Only applies if Font size mode is set to Fixed.

The Font size (top) property specifies the font size of the top text on the control. Only applies if Font size mode is set to Fixed.

The Font size mode property specifies the method used to size the text on the control. Options include:

• Auto — Automatically size the text relative to the size of control.
• Fixed — Size the text using the values specified in the Font size property.

The default value is Auto. The default value for the text tool is Fixed.

Alarm Grid —

A generic column can display any kind of scripted data of your choosing using C# or VB.NET at runtime. First configure the column in Canvas and then reference the column by name to pull in CygNet or other values. A generic column can be used to discover data defined in a supporting script. If the column is defined, but no data is defined, then the column is hidden by default.

The cells in a generic column can be configured to be editable in run mode, so that, for example, users could make quick data changes to facilities in a grid format. Changed values are not saved anywhere but in the grid, but they can be saved or otherwise manipulated via script.

CygNet Grid —

A generic column can display any kind of scripted data of your choosing using C# or VB.NET at runtime. First configure the column in Canvas and then reference the column by name to pull in CygNet or other values. A generic column can be used to discover data defined in a supporting script. If the column is defined, but no data is defined, then the column is hidden by default.

The cells in a generic column can be configured to be editable in run mode, so that, for example, users could make quick data changes to facilities in a grid format. Changed values are not saved anywhere but in the grid, but they can be saved or otherwise manipulated via script. Note that when a generic column is set to editable the Color properties are not configurable.

The Grid color property specifies the color of the lines in the layout grid.

Click to customize the color using the color picker.

The Grid color source property specifies the color source for the layout grid on the screen. Two options are available:

• Auto — Overrides the grid layout color with a theme-appropriate color (default). Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
• <Self> — The color selected in the Grid color property will be used.

The default options is Auto.

The Grid height property specifies the height of the layout grid. The default is 10 pixels high.

The Grid width property specifies the width of the layout grid. The default is 10 pixels wide.

The Group name property specifies the name of the group that indicates which radio buttons are mutually exclusive.

The Group service property specifies the service to use for this tag chooser. Click to select a Group service using the Select Service dialog box.

The Height property specifies the height of the control (or screen).

The Hide invalid tag check box indicates whether to hide the control if it resolves to an invalid or unknown tag.

The Hierarchy type property is used to select the service type by which the tag chooser's facilities will be organized: by Facility service or by Group service.

The High range color property specifies the color to be used at the high end of the value range. Click to customize the color using the color picker.

The Horizontal alignment property specifies the horizontal position of the text within the boundary of the control. Click to select from the following options: Left, Right, Center, or Justify. The default value is Center.

The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include:

• None — No resizing occurs.
• Shift — The object will shift horizontally.
• Expand — The object will expand or shrink horizontally the same number of pixels as the screen.
• Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

The Hover mode property specifies the mode when hovering over a series in the chart. Two options are available:

• None — No change to the other series in the chart.
• Fade other series — When hovering over a series, all other series in the chart are faded.

The default value is None.

You can use this setting to highlight a particular series in a chart in run mode.

The Icon path property specifies the icon to display to the left of a top-level menu item. Click to select an image file from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. This option is not available for sub-menu items.

The Icon preview property displays a preview of the selected icon. This option is not available for sub-menu items.

The Icon size property is used to set the dimensions of the menu icon. The range is 8 to 40 pixels. The default is 16 by 16 pixels.

The Ignore UDCs property specifies a comma-separated list of UDCs to hide when displaying points in the tag chooser. Type any UDCs you wish to hide, e.g. SYFACDESC, SYFACINFO

The Image property indicates the file path and file name of the image that will be substituted when the point state changes to the selected point state. Browse and select the desired image file. Click to select a path and file from the Open dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. A thumbnail of the selected image, and its dimensions are displayed for each point state.

This property specifies the path to the file, image file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Open File dialog box — To access a local or network Windows file-system folder
• Select File dialog box — To access a CygNet APPS or BSS folder

This property specifies the source to the file, image, object file, or screen. Options include:

• BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
• Local — Indicates that the file is stored in a local or network Windows file-system folder

The default file source is Local.

The read-only Image height property specifies the height of the image used in the control if no point-state-aware image is displayed.

The read-only Image width property specifies the width of the source image used in the control if no point-state-aware image is displayed.

The Image Selection dialog box is where you configure CygNet-aware images that will dynamically change based on the point state of the associated point. The point state preference is configured in the Resolution mode property. A default image is displayed if you configure point-state-aware images and no matching state exists.

Click to open the Image Selection dialog box.

The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True.

The Is logarithmic property indicates whether the gauge scale is linear or logarithmic.

The Is pan zoom control visible check box indicates whether to display the pan and zoom control on the screen in run mode. Pan and zoom are always enabled in design mode; the control is optional in run mode.

The Is pan/zoom enabled check box indicates whether the user can pan horizontally and vertically or zoom in and out of the screen. Both panning and zooming change the view — the current location and magnification of the screen. Every time you zoom or pan, you establish a new view. Pan and zoom are always enabled in design mode; the control is optional in run mode.

The Is separator check box indicates whether this menu item will be a separator line in the menu at runtime. Once saved the separator has no configuration and no children. Separators do not have event IDs. Any event ID on a menu item when it’s converted to a separator is deleted. You can give it a title of 'Separator" or "----------" if desired.

The Combo Box Items dialog box displays all the item labels that will appear in the combo box and their corresponding values.

Click to open Combo Box Items dialog box.

The Items to filter property specifies the number of items to filter if the Filter type is set to Top or Bottom.

Chart —

The Label property specifies the identifier displayed on the quick range button.

Check Box —

The Label property specifies the text label to display next to the check box. By default, the label appears to the right of the check box.

Combo Box —

The Label property specifies the label for an item in the combo box drop-down menu.

Radio Button —

The Label property specifies the text label to display next to the radio button.

Chart —

The Label background color property specifies the background color of the label associated with the point in the chart series. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label background color property specifies the background color of the label associated with the point in the default chart series.

Click to customize the color using the color picker.

The Y-axis Label color property specifies the color of the y-axis label text. Click to customize the color using the color picker.

Scripting Note

Prior to v9.5 the script property name for LabelColor was YAxisLabelColor, which is now obsolete, although it is retained for backwards compatibility.

Use Chart.AxisY LabelColor string to manipulate a y-axis in script. For example:

Chart —

The Label connector color property specifies the color of the label border and the connector line linking the label to the point in the chart series. The Show labels property must be enabled to change the color of the label connector. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label connector color property specifies the color of the label border and the connector line linking the label to the point in the default chart series.

Click to customize the color using the color picker.

The Label on Left check box indicates if the label should be shown on the left side of the check box.

Chart —

The Label text color property specifies the color of the text on the label associated with the point in the chart series. The text color is sometimes known as the foreground color. The Show labels property must be enabled to change the text color on the label. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label text color property specifies the color of the text on the label associated with the point in the default chart series. The text color is sometimes known as the foreground color.

Click to customize the color using the color picker.

The Layer property specifies the name of the layer to which this object is assigned. Layers can be used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.

• Type the name of the layer into the Layer field (the name can be a previously created layer or a new layer).
• All layers are listed on the Layers pane, where you can manage the layers for the screen in design mode and run mode.

The Legend date format property specifies the format for the dates used in the chart legend.

The Legend format property specifies the format for the text used in the chart legend. Build a dynamic text string, based on real-time CVS point properties, point configuration properties, and facility properties, using text tokens to represent a CygNet point attribute. Click to configure text and property strings using the CygNet Property String dialog box. The default format is %SiteService%:%PointIdLong%. For example, CYGDEMO.UIS: <FACILITY_UDC>.

If you leave this property empty, the chart will use the series Name value in the legend.

The Legend location property specifies where the chart legend should appear, if it is shown. Options include: Left, Top, Right, or Bottom. The default value is Bottom.

The Legend value format property specifies the format for the legend's point value using any of the valid .NET standard or custom numeric format strings. The value format applies to a point's value, primary value, and alternate value properties.

The Line color property specifies the color used for the border line of the shape control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Line style property specifies the style of the shape's border line. Click to select from the following options: Custom, Solid, Dashed, and Dotted. The default value is Solid. Select Custom to define your own line style and enter the values in the Custom line style property.

The Line width property specifies the width of the shape's border line.

The Lock property indicates whether the control is locked to the current position. A locked control cannot be moved via click and drag, or nudged with the arrow keys, or resized.

The Long point ID property specifies the long point ID of the CygNet point for which the control is to display data. Type the tag into the field.

The Low range color property specifies the color to be used at the low end of the value range. Click to customize the color using the color picker.

The Lower value bound property specifies the lower value to use when filling the control.

The value bound can be explicitly configured (by selecting <Self>) or the value can be sourced from an attribute of the associated point (by selecting Point Attribute). The following fields are available to store an attribute that can be used to indicate the value bound.

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the value bound in the Value field.
  • Point Attribute — Select Point Attribute to specify that the source of the value bound corresponds to a point attribute of the associated point represented in the control.
• Value — Configuration depends on the source:
  • If the Source is <Self>, select a number using the spin control. The default value is 0.
  • If the Source is Point Attribute, click to select from the following point attribute options:
    • Indexed 1, 2, 3 attributes — An application-specific point property of the associated point. The property that is included in a defined PNT index. This can be free-form text up to 15 characters. Three indexed fields are available for configuration on the Application page of the PNT Editor. See Application Properties for more information.
    • General 1, 2, 3 data field attributes — An application-specific property of the associated point. The point property can be free-form text up to 20 characters. Three data fields are available for configuration on the Application page of the PNT Editor. See Application Properties for more information.
    • Minimum setpoint — Note: Applies only to Analog points types.
      • For Analog Output points, this specifies the minimum allowable setpoint for the associated point.
      • For Analog Input points, this specifies the low range for point values for the associated point.
      • Configured on the Analog page of the PNT Editor. See Analog Properties for more information.
    • Maximum setpoint — Note: Applies only to Analog points types.
      • For Analog Output points, this specifies the maximum allowable setpoint for the associated point.
      • For Analog Input points, this specifies the high range for point values for the associated point.
      • Configured on the Analog page of the PNT Editor. See Analog Properties for more information.

See Value bounds and Upper value bounds.

The Main screen path property specifies the path to the Canvas file that will be displayed when you click (Maximize) to maximize the tile and display a screen at the top of the tile view when in run mode. Click (Minimize) again to return to the tiled view.

To configure the screen path click to open the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder.

The Marker border color property specifies the color used for the border of the triangular marker in the value indicator.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker color property specifies the color used for the value marker on the donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker fill color property specifies the color used for the interior of the triangular marker in the value indicator.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker height property specifies the height of the triangular marker for the point value on the donut.

The Marker width property specifies the width of the triangular marker for the point value on the donut.

The Maximum Y value property specifies the maximum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

The Navigator Menu Configuration dialog box displays all the menu items that will appear in the navigator's menu, and each menu item's properties: label, screen path, whether this screen is the start screen, icon path, and an icon preview.

Click to open the Navigator Menu Configuration dialog box.

The Menu item label property specifies the label for an item in the navigator menu.

The Menu width property specifies the width of the main navigator menu in expanded mode. The default value is 150 pixels. The minimum width is 40 pixels.

The Minimum Y value property specifies the minimum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

The Mouse cursor property determines which mouse cursor will appear when the mouse hovers over this control. Select an option from the drop-down menu: Arrow (), Hand (), Wait (), or Help (). The default cursor is the Arrow ().

The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Special characters and spaces are not allowed. Names cannot start with a number; an underscore will be prefixed if the control name starts with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane.

The Name specifies the name that appears in the column header.

The Name property specifies the label for the selected chart series, which is displayed in the upper right corner of the chart.

The Object limit property specifies the maximum number of objects to be added to each page of the container. Use this value to limit the number of objects and improve performance when loading an unexpectedly large number of objects.

This property specifies the path to the file, image file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Open File dialog box — To access a local or network Windows file-system folder
• Select File dialog box — To access a CygNet APPS or BSS folder

This property specifies the source to the file, image, object file, or screen. Options include:

• BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
• Local — Indicates that the file is stored in a local or network Windows file-system folder

The default file source is Local.

The Override chart dates check box indicates whether to use the screen's dates, when displaying charts for this screen.

Select the Override chart's facility check box to specify a different facility for this chart series. Once checked a facility field is revealed where you can override the facility configured for the chart. The chart's facility is specified in the CygNet Connection property group.

If Override chart's facility is selected the Resolve to a relative facility option is removed.

Select the Override chart's SiteService check box to specify a different SiteService for this chart series. Once checked a SiteService field is revealed where you can override the SiteService configured for the chart. The chart's SiteService is specified in the CygNet Connection property group.

The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

The Paging enabled check box indicates whether to enable a navigation interface to page through the remainder of the objects that exceed the Object limit property.

• If paging is enabled a pagination toolbar is added to the bottom of the object container, indicating the total number of pages, with buttons for paging through the objects. In run mode use the arrows and page numbers to click through the pages of objects.

Pagination interface at the bottom of an object container

• If paging is disabled a message displays indicating that the maximum number of objects is reached (as specified in the Object limit property) and the total number of objects available.

Pagination interface at the bottom of an object container

The Pan mode property allows users to pan in the chart plot area when there is a dense area of data points that cannot be seen clearly at the normal chart scale. With Pan enabled you can reduce or expand the area you want to examine using the scroll bars, and then drag the chart within the pan region horizontally, vertically, or in both directions. Options include:

• None — Panning with the mouse is disabled.
• Horizontal — Panning with the mouse is enabled only on the horizontal axis.
• Vertical — Panning with the mouse is enabled only on the vertical axis.
• Both — Panning with the mouse is enabled both on the horizontal and vertical axes. You can use this value to remove any restrictions, thus the chart can be panned on both the horizontal and vertical axes.

The default value is None.

See Pan Offset Changed for related event.

The Path property specifies the path to the global settings file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Open File dialog box — To access a local or network Windows file-system folder
• Select File dialog box — To access a CygNet APPS or BSS folder

The Rollup period property works in conjunction with the Rollup unit to define the interval by which a specified Rollup type takes place. For example, if you selected Minutes from the Rollup unit drop-down menu, then typed 3 in the Rollup period field, rollups for the control would occur every three minutes. Enter only whole numbers.

The Point property is used to determine how the CygNet point will be configured. Click the appropriate radio button to reveal the desired field.

• UDC — The UDC property specifies the UDC for which the control is to display data. Click to select a UDC using the Select UDC dialog box.
• Long point ID — The Long point ID property specifies the long point ID of the CygNet point for which the control is to display data. Type the tag into the field.

The Point attribute property specifies the CygNet point attribute that will be displayed in the column. Click to reveal a drop-down menu of all available CygNet point attributes categorized by type:

• Current Values (The default value is Value.)
• Point: General
• Point: Alarm
• Point: Point Reference
• Point: Application
• Point: Scaling
• Point: Hyperpoint
• Point: Alarm (Scheme 0)
• Point: History
• Current Value Status Bits

Click to expand each category and select the desired point attribute.

Alarm Grid —

A point column presents data for a point by UDC and point attribute. You can choose to resolve the point to a relative facility if desired. The property sheet displays Common and Point properties. Point column types also support a Summary row at the bottom of the grid that can show the following values for the data in the column: a total Count, a Sum, the Min value, the Max value, the Min and Max values, and the Mean value.

CygNet Grid —

A point column presents data for a point by UDC and point attribute. You can choose to resolve the point to a relative facility if desired.

Point column types also support a Summary row at the bottom of the grid that can show the following values for the data in the column: a total Count, a Sum, the Min value, the Max value, the Min and Max values, and the Mean value.

The Point configuration property is used to configure the CygNet point associated with the control. Click to reveal a drop-down area where you can configure the Selection mode, source Facility tag, source SiteService, source Facility, and the UDC or Long Point ID for the point. Each option is described below.

See each control for more information about configuring points.

The point scheme defines the point types, point alarms, point statuses, and default colors for a CygNet domain.

The Point size property specifies the size of the point displayed on the default chart series. The default value is 5.

Point state is the highest precedented state for a point record as defined for each point scheme. The point state for a point record is based on 48 System, Configuration, and User status bits, which are associated with the four point types (Analog, Digital, String, Enumeration). A point record may contain up to 48 status bits, which are used to provide point status information about the point record in a CVS and the ELSALM. A point can be in multiple states at the same time, for example, in High Warning and High Alarm; however, the state defined to be the most severe is the one that is used for the point state (i.e., High Alarm, in this case).

The point types are configured for the selected point scheme for your CygNet system. The default CygNet Standard Point Scheme has eight point types: Analog Input & Analog Output, Digital Input & Digital Output, Enumeration Input & Enumeration Output, and String Input & String Output.

The Y-axis Position property specifies the location of the y-axis on the chart. Options include: Left or Right. The default value is Left.

Scripting Note

Prior to v9.5 the script property name for Position was YAxisLabelPosition, which is now obsolete, although it is retained for backwards compatibility.

Use Chart.AxisY Position to manipulate a y-axis in script. For example:

Use the Properties to Search property to select the facility properties that will be searched in the search box. Click to open the Properties to Search dialog box and select the facility properties and attributes to use. Searching many properties and searching non-indexed properties may negatively impact performance. The default properties are Facility Description and Facility ID.

The Quick range buttons property group contains properties used to configure the quick range buttons that will appear on the chart's toolbar in run mode. In the Quick range buttons section, do the following:

See Use point state color?

The Read only property indicates whether the cells in a Generic column are editable. (Generic column only)

The End relative date or Relative end date or End property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.

Relative Facility Tree —

The Relative link property is where you configure the relative facility link for the relative facility tree. Click to reveal a drop-down menu of all available relative links. Select a link from the list.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Resolution mode property determines how a point's status should be used to select images to display. The control will display an image based on the point state or the alarm condition of the associated point. The point state of the associated point is evaluated to determine which image to display. Options include:

• Point state — all possible point states are included
• Alarm condition — only point states marked explicitly as an alarm condition in the CVSMetadata are included (point states with the alarm condition attribute set to "true")

The default option is Point state. Point-state-aware images are configured in the Images property.

The Resolve filter if no facility check box indicates whether to use the facility filter to resolve against all facilities if no facility is provided. If a facility is set for the object container, then it will search the child facilities of that facility using the provided facility filter. By enabling Resolve filter if no facility, the object container will use the provided facility filter against all facilities for the specified SiteService.

The Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed.

See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.

The Ring color property specifies the color used for the outer ring that represents the point value in the donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. the color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
2. the color will be sourced from the point state of the associated point (by selecting Point State)
3. the color can be customized (by selecting <Self>)

The default value is Auto.

Options include:

• Source — Click to reveal three options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Rollup property group contains properties that determine how data is rolled up in the chart series, such as type, units, period, and offset.

The Rollup period property works in conjunction with the Rollup unit to define the interval by which a specified Rollup type takes place. For example, if you selected Minutes from the Rollup unit drop-down menu, then typed 3 in the Rollup period field, rollups for the control would occur every three minutes. Enter only whole numbers.

Chart, Screen, Object —

By default, a rollup derives its values from raw data stored in the Value History Service (VHS). The Rollup type drop-down menu enables you to rollup data for the selected point. Using the Rollup type option might be preferable to using the data thinning option because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to data thinning. Rollup type options are as follows:

• None (default)
• Calculated weighted average
• Calculated mean
• Calculated minimum
• Calculated maximum
• Calculated delta
• Calculated last
• Thin median
• Thin minimum / maximum
• Thin last

Heap Map —

By default, a rollup derives its values from raw data stored in the Value History Service (VHS). The Rollup type drop-down menu enables you to rollup data for the selected point. Using the Rollup type option might be preferable to using the data thinning option because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to data thinning. Rollup type options are as follows:

• None
• Calculated weighted average
• Calculated mean (default)
• Calculated minimum
• Calculated maximum
• Calculated delta
• Calculated last
• Thin median
• Thin minimum / maximum
• Thin last

Tree Map —

By default, a rollup derives its values from raw data stored in the Value History Service (VHS). The Rollup type drop-down menu enables you to rollup data for the selected point. Using the Rollup type option might be preferable to using the data thinning option because rollup calculations performed by the VHS can provide improved performance and reduced network traffic relative to data thinning. Rollup type options are as follows:

• Calculated weighted average
• Calculated mean (default)
• Calculated maximum
• Calculated minimum
• Calculated last
• Calculated delta

Chart, Screen, Object —

The Rollup unit property options define the time units by which a specified Rollup type takes place. The Rollup Unit options are as follows:

• None (default)
• Minutes
• Hours
• Days
• Seconds

For instance, if you select Minutes, rollups occur on a minute basis. The interval is further defined by the Rollup Period setting, which defines how many (in this case) minutes long a rollup period is.

Heat Map —

The Rollup unit property options define the time units by which a specified Rollup type takes place. The Rollup Unit options are as follows:

• None
• Minutes
• Hours
• Days (default)
• Seconds

For instance, if you select Minutes, rollups occur on a minute basis. The interval is further defined by the Rollup Period setting, which defines how many (in this case) minutes long a rollup period is.

Tree Map —

The Rollup unit property options define the time units by which a specified Rollup type takes place. Rollup unit options are as follows:

• Days (default)
• Hours
• Minutes

For instance, if you select Minutes, rollups occur on a minute basis. The interval is further defined by the Rollup period setting, which defines how many (in this case) minutes long a rollup period is.

The Row configuration property is where you specify the source of the facility (and maybe the SiteService) for the row of the CygNet grid to use. The source for the facility can be explicitly configured for this row or it can be inherited from the screen or another control. If Row configuration is set to <Self> then you also need to provide a SiteService. This could be manually configured or inherited.

The Row header font size property specifies the font size for the text that lies to the left of each row in the heat map.

The Row height property specifies the height of each heat map row. Only applicable if the Row sizing mode is set to Fixed.

The Row sizing mode specifies the method used to size the heat map row height. Options include:

• Auto — Automatically size the rows based on the height of the heat map.
• Fixed — Size the rows using the value specified in the row height property. If this requires more vertical space than is available, a scroll bar will be added.

The default value is Auto.

The Row summary update rate property specifies the rate (in milliseconds) at which the grid will recalculate row summaries after a value changes in a point column. Longer rates will improve performance by not recalculating as often. When a value in a cell is updated, the summary row will be recalculated. However recalculation does not happen immediately or for every update; it is throttled by the Row summary update rate. When a recalculation is requested, Canvas will delay for the duration of the update rate. This allows other updates to come in that may affect the recalculated values. Recalculation requests that come in during that delay will be ignored. In this way, no matter how often values change, Canvas will not recalculate the summary row value more often than the set rate. The default value is 1000 milliseconds (1 second).

See Summary properties below for information about configuring grid row summaries.

This property specifies the source to the file, image, object file, or screen. Options include:

• BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
• Local — Indicates that the file is stored in a local or network Windows file-system folder

The default file source is Local.

This property specifies the path to the file, image file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Open File dialog box — To access a local or network Windows file-system folder
• Select File dialog box — To access a CygNet APPS or BSS folder

Linking between Canvas screens, objects, and nested views is quite flexible. You don't need to specify the service or folder information in the path to find related screens, objects, or nested views, although you can if desired. When specifying a path to another file, the following notes apply:

If the screen or object file is in the APPS or BSS, you can specify the:

• full path of the file
• folder\filename.can of the file (Canvas uses the source file's service)
• filename.can of the file (Canvas uses source file's service and folder)

If the screen or object file is in the local file system, you can specify the:

• full path of the file
• filename.can of the file (Canvas uses source file's path)

Navigator —

The Screen path property specifies the screen that will open in the body of the navigator. Click to select a screen from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. The option is not available for top-level menu items with sub-menu items.

Tab Control —

The Screen path property specifies the screen that will open in the body of the tab control. Browse for the screen file. If no screen is specified, the nested view does not display in run mode.

Click to select a path and file from the Open dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder.

The Script event ID specifies the event ID that will be called when the menu item is selected from the runtime right-click context menu. The event ID is passed in as a parameter into the Custom Context Menu Action event, along with other relevant information in the context of the click, for example, facility or point tag, as appropriate.

The Search custom check box indicates whether a custom search will be performed.

This property invokes the CustomSearch script property, a delegate that references a custom search method, when a user searches for a string.

Example

See Scripting Custom Searches for more information about this property.

The Search facilities check box indicates whether to search for facilities based on facility attributes, filter settings, and SiteService. The default value is True. This property works in conjunction with the Facility filter, Properties to search, and SiteService properties.

The Selected check box indicates whether the radio button initially displays as selected.

The Selected index property specifies a zero-based index for the selected tab. -1 indicates no tab is selected and no nested view will display in run mode. 0 indicates the first tab is selected; 1 indicates the second tab is selected; 2 indicates the third tab is selected; and so on.

Relative Facility Tree —

The Selected action property specifies the action to take when a result is selected. Options include:

• FacilitySender — The control acts as a facility sender and sends the selected facility to any controls configured to receive it. This only works if the selected result includes a facility.
• Navigate — The control will navigate to the selected facility's associated screen or the selected screen. The navigation mode is determined by the Facility navigation mode property setting on the screen displaying the control. See Navigation by Facility for more information.
• Script — Executes a script event (Item Selected) when selecting a facility from the tree.

The default value is FacilitySender.

Search Box —

The Selected action property specifies the action to take when a result is selected. Options include:

• FacilitySender — The control acts as a facility sender and sends the selected facility to any controls configured to receive it. This only works if the selected result includes a facility.
• Navigate — The control will navigate to the selected facility's associated screen or the selected screen. The navigation mode is determined by the Facility navigation mode property setting on the screen displaying the control. See Navigation by Facility for more information.
• Script —

  Executes a script event (Search Results Selected) when selecting a facility or custom item from the search results.

  Notes for the Search Box:

  • If you are setting up a facility search, and want to script the selection action, you also need to enable the Search facilities check box.
  • If you are setting up a custom search to query some other object, for example, a SQL database, a .csv file, even a website, you also need to enable the Search custom check box.
  • See Scripting Custom Searches for more information.

The default value is FacilitySender.

The grid controls offer three selection modes, which determine how many grid units may be selected in run mode. The grid units are determined by the Selection unit property. Options include:

• Single — Only one item can be selected at a time.
• Multiple — Items are added to the selection when they get clicked and get removed when they get clicked again.
• Extended — Items are added to the selection only by combining mouse clicks with the Ctrl key or Shift key.

The default value is Single.

In script, use SelectionMode with the SelectAll method and SelectedRows property (read-only) to aid in multi-row selection:

• SelectAll method — If the SelectionMode property is Multiple or Extended, SelectAll will select all rows in a grid and SelectedRows will return the matching DataRow objects. SelectAll will not obviously change the selection if SelectionMode is Single.
• SelectedRows property (read-only) — SelectedRows will be restricted to a single row if SelectionMode is Single. Otherwise SelectedRows can contain multiple rows to be retrieved via script.

The Selection mode property is used to determine how the control will receive CygNet information from other controls. Two options are available; click the desired radio button:

• Facility tag — The Facility tag selector consists of a Source chooser and Resolve to a relative facility check box. If the Source is <Self> a Facility tag selector and relative facility options are also displayed. Facility tag is the default option.
• SiteService / Facility — The SiteService / Facility selector consists of Source and SiteService and facility choosers.

Sending and receiving facility tags

Some controls on the same screen allow for the sending of facility tag information from one control to another.

1. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
2. On the receiving control configure the Selection mode property (in either CygNet connection or Point configuration section) to Facility tag and select the Facility Source to the sending control.
3. On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.

The CygNet grid control offers three selection units. The Selection unit property determines the grid units that may be selected in run mode. Options included:

• Cell — Only the clicked cell is selected. Depending on the value of the Selection mode property you can have more than one selected cell
• Full row — Clicking within any cell will select the entire row.
• Mixed — Select any cell and you can also select a full row if you click on a row, but not on a cell from it.

The default value is Full row.

The Series Configuration dialog box contains the properties required to configure each series on your chart. Each series is automatically assigned to a y-axis. You can add an unlimited number of y-axes to a chart and an unlimited of series to each y-axis. Although some properties of a series are inherited from the screen or from another object on the current screen, you can define properties specific to a certain series, in some cases overriding the inherited properties. The number of defined series is listed on the property label. Click to open Series Configuration dialog box.

The Series property group contains properties that configure the primary attributes of the chart series, such as name, UDC, color, SiteService override, facility override, and relative facility resolution.

The Series type property specifies the style to use for the chart series. Click to select an option from the drop-down menu. Options include:

• Bar — A bar chart visualizes data as a set of rectangular bars, with the length of each bar representing the value of each data point. Each bar is the color assigned to the series.
  • When adding a series showing custom non-CygNet data in a Bar chart type via script, you must set the color at the point level. This allows for points to be colored differently from each other.
• Line — A line chart shows information as a series of data points connected by straight lines. This is the default series type for the chart.
• LineArea — An line area chart is based on the line chart and shows information as a series of data points connected by straight lines, with the area between the X-axis and the line filled with the line color.
• Spline — A spline chart is a line chart where data points are connected by a smooth curve.
• SplineArea — A spline area chart is based on the spline chart where data points are connected by a smooth curve, with the area between the X-axis and the line filled with the line color.
• Step — A step chart is a line chart in which data points are connected by horizontal and vertical lines, looking like a series of steps.
• StepArea — A step area chart is based on the step chart where data points are connected by horizontal and vertical lines, looking like a series of steps, with the area between the X-axis and the steps filled with the line color.

Click here to see an example of each type of series.

The Shape geometry property specifies a special abbreviated syntax that defines the shape's geometry. If you want to manually modify these values, set the Shape type to Custom.

Shape —

The Shape type property specifies the type of shape to draw. Click to select from the following options:

• Circle
• Custom shape
• Diamond
• Double-ended horizontal arrow
• Double-ended vertical arrow
• Down arrow
• Left arrow
• Line (horizontal)
• Line (vertical)
• Right arrow
• Square
• Triangle
• Up arrow
• Valve (horizontal)
• Valve (vertical)

The default value is Custom shape. Select Custom shape to define your own shape and enter the values in the Shape geometry property.

The Show alarm icon indicates whether to show or hide the alarm icon in the detail control.

The Show alarm notifier property indicates whether the alarm notifier is visible on this screen when opened in Canvas View and Canvas View Lite. This property is set to true (On) by default and the alarm banner will always appear at the top of a screen in run mode, unless you turn it off in design mode.

The Show cell labels check box indicates whether to display the value in each cell. Note that displaying a value may have an impact on performance.

The Show configuration check box indicates whether to display the configuration field in run mode.

The Show context menu check box indicates whether a right-click context menu will be available or suppressed in run mode. The default context menu will allow alarm acknowledgment, access to point history and alarm history, point configuration, and facility configuration.

The Show date range button check box indicates whether to display a (Configure date range) button on the chart's toolbar in run mode. This button allows you to change the date and time range to be trended in the chart, whether to enable live data updates, the live update rate, the starting time for a trend, whether to use relative or absolute dates, and the actual date range. The default setting for this button is enabled. See To configure the date and time range for the current chart for more information.

The Show export buttons check box indicates whether to display a (Export as image) button and a (Export data to CSV) button on the chart's toolbar in run mode. The default setting for this button is enabled. See To export a chart for more information.

The Show grid property indicates whether to show the grid lines in design mode. By default the layout grid will be displayed. The grid will always be hidden in run mode.

The Show image property indicates whether to display an image on the button or within the text tool's boundaries.

The Show label check box indicates whether to display a label providing context for the summary row value. Options include: Sum:, Min:, Max:, MinMax:, Count:, and Mean:.

The Show labels check box indicates whether to display a label corresponding to each data point in the chart series when in run mode. The labels will dynamically reorient their position when you resize or reshape a screen.

The Show legend check box indicates whether to display the legend on the chart.

The Show live update button check box indicates whether to display the (Disable/enable live updates) buttons on the chart's toolbar in run mode. This button allows you to stop and start live updates for the chart. The default setting for this button is enabled. See To configure live updates for the current chart for more information.

The Show point labels check box indicates whether the series will display a label associated with each point value in the default chart series when in run mode. The labels will dynamically reorient their position when you resize or reshape a screen.

Chart (Series) —

The Show points check box indicates whether to display the points on the chart series. Once enabled, several other properties (color, size, and label attributes) become configurable.

Screen (Default Chart) —

The Show points check box indicates whether the series will display a point at the location of each value on the default chart series.

Tag Chooser —

The Show points check box indicates whether to display the points in the tag chooser. Points are designated with a blue circle () in the tag chooser hierarchy.

The Show primary scale property indicates whether to show the primary scale on the linear gauge. The primary scale shows the lower to upper bound values and includes major and minor tick marks.

The Show print button check box indicates whether to display a (Print current view) button on the chart's toolbar in run mode. The default setting for this button is enabled. See To print a chart for more information.

The Show quick range buttons check box indicates whether to display any configured quick range buttons, which are used to view predefined windows of time on the chart. Each button will reset the time range presented in the chart based on the button's configuration. For example, for a button configured for 8 hours, when clicked the chart’s time range will be set so that it begins eight hours from now with the left edge of the chart representing now. For a chart configured to be in live update mode, the chart will update to show this eight-hour window. The quick range only persists for the current runtime session. The default setting for this button is enabled, although buttons must be configured to display on the chart.

See To quickly view different time ranges for the current chart for more information.

The Show reset zoom button check box indicates whether to display a (Reset to unzoomed state) button on the chart's toolbar in run mode. This button allows you to return the chart to its original state after dragging, panning, or zooming. The default setting for this button is enabled. See To drag, pan, and zoom for more information.

The Show save and open buttons check box indicates whether to display a (Save the chart's configuration to a file) button and a (Open a previously saved chart) button on the chart's toolbar in run mode. The default setting for this button is enabled. See To save a chart's configuration as a default chart and To open a previously saved default chart and Default Chart for more information.

The Show scale check box indicates whether to display the color scale beneath the heat map.

The Show secondary scale property indicates whether to show the secondary scale on the linear gauge. The secondary scale shows the lower to upper bound values.

The Show sparkline indicates whether to show or hide a sparkline in the detail control.

The Show time slice check box indicates whether to display a vertical time slice that will snap to the nearest data point and call out the point value and timestamp for all series in the chart in run mode.

The Show Tooltips check box indicates whether to display tooltips when hovering over a data point or cell. When you hover over a data point or cell in run mode the tooltip displays the point value and timestamp. Only available when a control is showing points.

The Show top labels check box indicates whether to display the date and time labels along the top of the heat map.

The Show value marker check box indicates whether to show a triangular marker for the point value on the donut. The marker's color is configurable:

The Marker color property specifies the color used for the value marker on the donut.

See Color configuration: Marker color for more information.

The Show x-axis label check box indicates whether to display the label text on the x-axis, which is typically the unit of time being displayed in the chart.

The Y-axis Show axis label check box indicates whether to display the label text on the y-axis, which is typically the range of units being displayed on the chart.

Scripting Note

Prior to v9.5 the script property name for ShowLabels was YAxisShowLabels, which is now obsolete, although it is retained for backwards compatibility.

Use Chart.AxisY ShowLabels Boolean to manipulate a y-axis in script. For example:

The SiteService property specifies the SiteService for which the control (or screen or screen element) is to display data. Click to select a service using the Select Service dialog box.

The SiteServices property specifies the service(s) for which the search box is to display data. Click to select a service(s) using the Select Services dialog box.

The Size property indicates the size of the image on the control.

The Size property specifies the length in units of time for the range associated with the quick range button. The size is relative to the unit type specified in the Units property. For example, 60 seconds = 1 minute, 48 hours = 2 days, 30 days = 1 month, etc.

The Size property specifies the size of the point displayed on the chart series. The default value is 5. The Show points property must be enabled to change the point size.

Button —

The Size mode property specifies the method used to size the image used on the button so it can scale without distortion. The image will be resized if not square. Options include:

• Auto — Automatically size the image relative to the size of control.
• Fixed — Size the image size using the value specified in the Size property.

The default value is Auto.

Image —

The Size mode property specifies the method used to size the image used in the control so it can scale without distortion. Options include:

• Stretch — Resizes the image to fill the entire control, while maintaining its native aspect ratio.
• Auto — Displays the image using its raw size. If the image is too big to fit within the boundaries of the control, sizing follows the Stretch behavior.

The default value is Auto.

The Snap to grid property indicates whether controls should snap to the grid. The default value is true.

The Snap to items property indicates whether controls should snap to other controls. The default value is true.

The Sort numerically property specifies whether this column can be sorted numerically. In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.

The Source property specifies the source of the global settings file. Select from the following options:

• BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
• Local — Indicates that the file is stored in a local or network Windows file-system folder

The default value is BSS.

The Sparkline color (or Color) property specifies the color of the sparkline. Click to customize the color using the color picker.

The Begin date or Start or Start date property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Begin date or Start or Start date property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The Begin date property specifies the start date and time to use when rolling up historical data. Data between the Begin relative date and the Begin date will be rolled up and displayed in the tree map. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to a screen. Click to change the date using the date picker.

The Begin relative date property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Start screen check box indicates that this screen will be displayed in the Navigator when first opened. The option is not available for top-level menu items with sub-menu items.

The Stretch property describes how the shape is resized to fill its allocated space. Click to select from the following options:

• None — The shape preserves its original size.
• Fill — The shape is resized to fill the destination dimensions. The aspect ratio is not preserved.
• Uniform — The shape is resized to fit in the destination dimensions while it preserves its native aspect ratio.
• UniformToFill — The shape is resized to fill the destination dimensions while it preserves its native aspect ratio. If the aspect ratio of the destination rectangle differs from the source, the shape is clipped to fit in the destination dimensions.

The default value is Fill.

The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary.

The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type.

• Click to reveal a drop-down menu of predetermined styles configured for the selected control.
• Select a desired style and its properties will be applied to the control.
• Alternately, you can create a new style based on other property values configured for the control.
• Or you can select <None> to remove subscription to any style.

Styles are created in two ways:

• In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information.
• In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information.

The Sub-menu width property specifies the width of the expanded menu when a parent item is selected. The default value is 150 pixels. The minimum width is 40 pixels.

The Summary type property specifies the type of values presented in the grid summary row at the bottom of the grid. Click to select from one of the following options:

• Sum — The sum of the values
• Min — The minimum value
• Max — The maximum value
• MinMax — The minimum and maximum values
• Count — The total number of rows
• Mean — The mean value

See Row summary update rate above for information about the update rate at which the grid will recalculate row summaries after a value changes.

The Suppress data retrieval check box indicates whether all CygNet data retrieval is suppressed for this control. Use this if you want to store point information in the control but don't want the control to automatically query services for data. Tokens will not be replaced and point state colors will be ignored.

You can configure the control with a valid point configuration but the control will not retrieve any CygNet data. This allows you to display static text for a control, while still allowing CygNet data context available from script.

If a control has a point configured, but Suppress data retrieval is enabled, Canvas won’t do much point processing. The one exception is for point validity. If the control is configured to Hide invalid tag, then Canvas will check if the current tag is valid, even if Suppress data retrieval is enabled. This will allow you to configure some static text that will dynamically hide in the case of a templated screen for a facility that doesn’t have that particular point.

The Tab name property specifies the label for the tab in the tab control.

The Tab Configuration dialog box displays the tabs that will appear at the top of the tab control, and each tab's properties: the tab name and the path to the screen that will show in the optional nested view.

Click to open Tab Configuration dialog box.

If the number of tabs exceeds the width of the tab control container, arrows are added at the left and right side to allow you to navigate to the tabs you can't see.

The Text property specifies the text that will appear on the face of the control, which can be a static 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. Click to configure text and property strings using the CygNet Property String dialog box. For most controls there is no default. For the detail, donut, and tile view controls the default value is the %Value% token.

Edit Box —

The Text property specifies the text that will be displayed in the edit box in run mode. The edit box supports multi-line text entry in run mode only. A scroll bar will be added if the number of lines exceeds the height of the box. In design mode, the Text property allows unlimited text entry, although the display of multi-line entry is not supported, and any text that exceeds the right side of the edit box will not be visible in run mode.

The Text alignment property specifies the text alignment for the column. The options are Left, Right, Center, and Justify. The default value is Left.

The Text color property specifies the color used for the text of the grid cell. The text color is sometimes known as the foreground color. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is ForegroundColor.

Options include:

• Source — Click to reveal five options:
  • Auto — Select Auto to automatically follow the selected client theme regardless of the underlying color palette. Where applicable, color properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.
  • BackgroundColor — Select BackgroundColor to specify that the source of the icon's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the icon's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the icon's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.