The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. Names cannot start 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: Chart, Grid, Heat Map, Object Container, Tag Chooser, View, etc. … The control's Type is also displayed on the Controls view of the Screen pane.

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

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 Layer property specifies the layer for this control. Layers are 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.
• All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode.

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

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

The default value is None.

The Visible check box indicates whether the control is visible in run mode.

The Width property specifies the width of the control (or screen).

The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

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

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

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.

The Series configuration box contains all the properties required to configure a series on your chart. The number of defined series is listed on the property label. 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.

• Click to reveal the Series configuration box, which is organized into four property groups: Series, Appearance, Rollup, and Data source.
• Click Add series to add a new, blank series to a y-axis. Each new series is assigned a dynamically generated color, which can be changed later if desired. Complete the new series configuration to suit your needs using the properties described below. Alternately, you can locate the desired point or facility in the Tag Chooser pane and drag and drop it to your chart.

• Click to expand each property group. Click to collapse each property group.

• Click (Delete series) to remove a series from your chart.

• See To configure a chart series for more information.

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.

Click to expand the property group. Click to collapse the property group.

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

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.

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

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.

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 SiteService property specifies the SiteService for which the control (or screen) is to display data. Click to select a service using the Select Service dialog box.

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.

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

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

Click to expand the property group. Click to collapse the property group.

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.

The Color property specifies the color of the point in the chart series. The default value is the series color. Click to select a color using the color picker. The Show points property must be enabled to change the point color.

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.

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 Label background color property specifies the background color of the label associated with the point in the chart series. Click to select a color using the color picker. The Show labels property must be enabled to change the background color of the label.

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. Click to select a color using the color picker. The Show labels property must be enabled to change the text color on the label.

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. Click to select a color using the color picker. The Show labels property must be enabled to change the color of the label connector.

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

Click to expand the property group. Click to collapse the property group.

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

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.

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

The Data source property group contains properties that determine from where the series' data is sourced.

Click to expand the property group. Click to collapse the property group.

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 the examples provided below.

Scripting a Chart Series

The following example guides you though creating a scripted chart series, adding delegates to show random data and auto update the series, and some important notes.

1. Configure a chart, add a series, and for the Data source property select Script as the source.
2. Switch to the Script View and enable scripting for this screen.
3. In the script for the screen, add a GetCustomSeriesData method below the //add custom methods here comment in the public class ScreenClass class. See the following example. This example also includes a GetCustomSeriesAutoUpdateData method to handle an auto updating series. Also see the comments showing the ability to handle multiple scripted series.

4. The above method has a parameter with a data type of 'Series', which is included in the Canvas.Shared.Models namespace. So, at the top of the script you need to add a statement to indicate this:

5. Next you need to add the delegates, which are used, for example, to reference the custom scripted data or instruct the series to auto update.
6. Go to the Events tab and enable the Initialize event on the screen. This is where you hook the delegates:

Other Script Notes

• The AddData method on a series object is used to add a value at the supplied time. AddData has three parameters:

• DateTime — Type of "DateTime"
• Value — Type of "Double"
• Color — Type of "String". This is an optional parameter. See the next note about bar charts and color.

Here is an example of adding a point to the chart.

• When adding a Bar Series type, you must set the color at the point level. This allows for points to be colored differently from each other. Color is an optional parameter on the AddData method; but it must be supplied for a bar chart.

• When adding a scripted data source, set the Delay loading property to True to give the script time to set the delegates before data retrieval begins. The chart needs to be refreshed after the delegates are connected. See example above.

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

The Update rate property specifies the number of milliseconds to wait before an auto-updated trend refreshes. The default rate is 200 milliseconds.

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 Use relative date check box indicates whether to use relative dates and time for the chart. Use the Begin/Start and End properties to specify the relative date ranges to use in the chart.

If Use relative date is unchecked all dates and time will be absolute. Use the Begin/Start and End properties to specify the absolute date ranges to use in the chart.

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 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 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 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 <Self>, Screen (default), or a list of Sender controls.
  • <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 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 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 X-axis label color property specifies the color of the x-axis label text. Click to select a color using the color picker.

The X-axis label position property specifies the location of the label text on the x-axis. Options include: Top or Bottom. The default value is Bottom.

The X-axis tick color property specifies the color of the tick lines for the x-axis. Click to select a color using the color picker.

The Show y-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.

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

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

The Y-axis tick color property specifies the color of the tick lines for the y-axis. Click to select a color using the color picker.

The Toolbar location property specifies the location of the toolbar. Options include Top or Bottom. The default location is above the chart (Top).

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

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.