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 read-only Type property displays the type for the control: Button, Chart, CygNet Grid, Edit Box, Object Container, Search Box, Tag Chooser, etc. … The control's Type is also displayed on the Controls view of the Screen pane.

The Background color property specifies the color used for the background of the control. 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 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.

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 Title property specifies the menu name to be displayed in the runtime context menu.

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 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 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 Title property specifies the title of this screen.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

The Rollup top of subunit property enables you to specify the time offset by which a rollup is evaluated with greater precision. Subunit refers to the next smaller unit of time from the time unit defined in the Rollup unit property. So, if Rollup unit is set to hours, the implied rollup subunit would be set to minutes. The numeric value is the number of subunits added to starting time of each cell or series.

Using the example of hours and minutes, if the starting time of an item would otherwise have been 09:00 AM, if subunits is set to 15, the starting time of that item would be 09:15 AM.

See Default Chart for more information.

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>.

See Interscreen Communication for more information about using this property.

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>.

See Interscreen Communication for more information about using this property.

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.

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 Facility tag or Facility property is where you specify the source of the facility for the control (or screen) to use. The source for the facility can be explicitly configured for this control or it can be inherited from another control on the same screen, or from the screen, or from another screen. Click to reveal the Facility tag or Facility selector. Options include:

• Source — Options include <Broadcast>, <Self>, or a list of Sender controls.
  • <Broadcast> — Select <Broadcast> to indicate that the facility is sourced from another broadcasting screen.
  • <Self> — Select <Self> to explicitly configure the facility for this control. A Facility tag or Facility selector is displayed, depending on the Selection mode:
    • Facility tag — 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.
    • Facility — 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.
  • 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.

• Resolve to a relative facility — 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.
  • Relative link — 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.
  • Order in type — 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 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 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 Snap to grid property indicates whether controls should snap to the grid. The default value is true.

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

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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.

See Default Chart for more information.

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

See Default Chart for more information.

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.

See Default 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.

See Default Chart for more information.

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