Chart Properties

Property icon The Chart supports the following properties, which are available via the Properties pane and the Canvas script editor. Click next to any property name in the Properties pane to see a short description for the selected property.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

Categorizing, Sorting, and Finding Properties

You can click Categorize (Categorize), click Alphabetize (Alphabetical within Category) or click Search (Search) within the properties using the features located immediately above the properties list. The search box is useful to help locate a property when an object contains many properties. For clarity, when you enter a search term, items matching your entry string remain displayed and non-matching items are temporarily hidden. Clear the search box to display the full properties list again.

You can expand and collapse each property category by clicking Down arrow or Up arrow next to the group name or simply clicking anywhere in the category heading.

Chart Properties

The following table describes the property names visible in the Properties pane user interface (UI) and the corresponding script property name.

UI Property Script Property Description
Name Type Style

Name

ControlName

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

Type

ControlType

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.

Style

 

Not supported by TWC 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 Down arrow 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 (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.

Tip: You can also change a control's Style on the Controls view of the Screen pane.

LocationBack to top

Height

Height

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

Tip: You can also change the height of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Horizontal resize mode

HorizontalResizeMode

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.

Layer

Layer

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

Tip: You can also edit a control's Layer on the Controls view of the Screen pane.

Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, SetLayerVisibility, and ShowLayer methods on the Screen object.

Lock

IsLocked

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

Tip: You can also toggle the lock setting of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode).

Vertical resize mode

VerticalResizeMode

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.

Visible

IsVisible

Not supported by TWC The Visible check box indicates whether the control is visible in run mode.

Tip: You can also change a control's Visible setting on the Controls view of the Screen pane.

Width

Width

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

Tip: You can also change the width of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

X

X

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.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

Y

Y

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.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

Z index

ZIndex

The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer).

Tip: You can also change the Z index of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

ScriptBack to top

Include in script

Scripting is not supported by TWC 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.

Tip: You can also change the Include in Script setting on the Controls view of the Screen pane.

ChartBack to top

Background color

BackgroundColor

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

Background color source

BackgroundColorSource

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

    Note:  Not supported by TWC  Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — The color selected in the Background color property will be used.

The default option is Auto.

Chart drop mode

ChartDropFacilityMode

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

Delay loading

DelayLoading

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

Hide unreliable points

AreUnreliablePointsHidden

The Hide unreliable points property indicates whether to hide a point in the chart series based on its unreliable point state. The UNRELIABLE status bit is set when a point is deemed unreliable. When enabled data points marked as unreliable will be hidden in the chart. When disabled, unreliable data points will be shown in the chart.

Hover mode

HoverMode

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

Series

AxisY

Series

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 received 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 Configure series to open Series Configuration dialog box.

The Y-axis properties are grouped into the Y-axis property group. The Series properties are organized into four property groups:

Series > Y-axis property group

AxisY

The Y-axis property group contains properties that configure the attributes of the y-axis, such as title, position, color, tick color, and visibility.

Click Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

Title

Name

The Y-axis Title property specifies the text for the y-axis title. The y-axis typically displays increments of data according to the data's relevant unit type. The unit type derives from the associated data type's point record in the Point Service (PNT). The set Title is Values, which cannot be changed.

Scripting Note

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

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

Copy
AxisY Name property
var axis = Objects.Chart1.AxisY.First();
 
axis.Name = "Custom (Values) Updated ++";

Note that Scripting is not supported by TWC

Position

Position

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:

Copy
AxisY Position property
var axis = Objects.Chart1.AxisY.First();
 
axis.Position = HorizontalPosition.Right;

Note that Scripting is not supported by TWC

Label color

LabelColor

The Y-axis Label color property specifies the color of the y-axis label text. Click Down arrow 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:

Copy
AxisY LabelColor property
var axis = Objects.Chart1.AxisY.First();
 
axis.LabelColor = System.Windows.Media.Colors.Yellow.ToString();

Note that Scripting is not supported by TWC

Tick color

TickColor

Not supported by TWC The Y-axis Tick color property specifies the color of the tick lines for the y-axis. Click Down arrow to customize the color using the color picker.

Scripting Note

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

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

Copy
AxisY TickColor property
var axis = Objects.Chart1.AxisY.First();
 
axis.TickColor = System.Windows.Media.Colors.Yellow.ToString();

Note that Scripting is not supported by TWC

Show axis label

ShowLabels

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:

Copy
AxisY ShowLabels property
var axis = Objects.Chart1.AxisY.First();
 
axis.ShowLabels = true;

Note that Scripting is not supported by TWC

Series > Series property group

Series

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 Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

 

 

 

 

Name

 

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

UDC

 

The UDC property specifies the UDC for which the control is to display data. Click Open dialog box to select a UDC using the Select UDC dialog box.

Color

 

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

Note: The default colors used for a Chart series are drawn from a set palette and are therefore not theme-specific. See themes for more information.

Series type

 

The Series type property specifies the style to use for the chart series. Click Down arrow 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. Not supported by TWC
    • 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. Not supported by TWC
  • Spline — A spline chart is a line chart where data points are connected by a smooth curve. Not supported by TWC
  • 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. Not supported by TWC
  • 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. Not supported by TWC
  • 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. Not supported by TWC

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

Override chart's SiteService

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

(override) SiteService

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

Override chart's facility

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.

(override) Facility

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

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

Series > Appearance property group

Not supported by TWC 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 Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

Show points

 

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

Color

 

Not supported by TWC 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 Down arrow to customize the color using the color picker.

Size

 

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

Show labels

 

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

Label background color

Not supported by TWC The Label background color property specifies the background color of the label associated with the point in the chart series. Click Down arrow to customize the color using the color picker.

Label text color

Not supported by TWC 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 Down arrow to customize the color using the color picker.

Label connector color

Not supported by TWC 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 Down arrow to customize the color using the color picker.

Series > Rollup property group

Not supported by TWC 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 Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

Type

 

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

Additional Resources

For more information about Rollup Type definitions and about how history values are used in rollups, see History > History Data > History Rollups.

Units

 

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

Period

 

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

Top of subunit

 

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

Series > Data source property group

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

Click Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

Data source

GetCustomSeriesData

GetCustomSeriesAutoUpdateData

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

Show time slice

ShowTimeSlice

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

 

Chart time slice

Chart time slice

Show tooltips

ShowTooltips

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

 

Chart tooltip

Chart tooltip

X-AxisBack to top

Show x-axis label

XAxisShowLabels

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

X-axis label color

XAxisLabelColor

Not supported by TWC The X-axis label color property specifies the color of the x-axis label text. Click Down arrow to customize the color using the color picker.

X-axis label position

XAxisLabelPosition

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

X-axis tick color

XAxisTickColor

Not supported by TWC The X-axis tick color property specifies the color of the tick lines for the x-axis. Click Down arrow to customize the color using the color picker.

X-axis title

XAxisTitleText

Not supported by TWC The X-axis title property specifies the text for the x-axis title. The x-axis typically shows the time frame being displayed on the chart. The default value is Time.

RangeBack to top

Date range configuration

DateConfig

RelativeRanges

SelectedRelativeRange

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 Open dialog box 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.

Date range config >

Enable live updates

AutoUpdate

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 live updates /enable live updates for any chart in run mode via an icon on the chart toolbar. See Live Update Changed for related event.

Date range config >

Update rate

AutoUpdateRate

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

Date range config >

Earliest (span)

AutoUpdateEarliestSpan

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.

Date range config >

Earliest (units)

AutoUpdateEarliestUnit

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.

Date range config >

Use relative date

UseRelativeTime

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.

Date range config >

Start (relative date)

RelativeStart

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.

Date range config >

End (relative date)

RelativeEnd

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.

Date range config >

Start (absolute date)

DateStart

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 Set date to change the date using the date picker.

Date range config >

End (absolute date)

DateEnd

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 Set date to change the date using the date picker.

CygNetBack to top

CygNet connection

CygNetConfiguration

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 Down arrow to reveal a drop-down area where you can configure the Selection mode, source SiteService, and source Facility. Each option is described below.

CygNet conn >

Selection mode

CygNetConfiguration.SelectionMode

The Selection mode property is used to determine how the control will receive CygNet information from other controls or from itself. 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 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%.

Example

Add a control to a screen (e.g., a Tag Chooser or Grid) and configure it as a facility sender to send a facility to the screen. Add another control to the screen (e.g., a Text Tool or Donut) and configure it to receive the facility from the screen. In this scenario the Tag Chooser or Grid will send a facility to the screen and the screen will then send the facility to a Text Tool or the Donut.

CygNet conn > Facility tag

CygNet conn > Facility

CygNetConfiguration.Facility

CygNetConfiguration.FacilityTag

CygNetConfiguration.SourceFacilityTag

FacilitySender

IsRelativeFacilityResolutionEnabled

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 received from another control on the same screen, or from the screen, or from another screen. Click Down arrow 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 Open dialog box 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 Open dialog box 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 Down arrow 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.

CygNet conn >

SiteService

CygNetConfiguration.SiteService

SiteServiceSender

The SiteService property is where you specify the source of the SiteService for the control (or screen) to use. The source for the SiteService can be explicitly configured for this control or it can be received from another control on the same screen, or from the screen, or from another screen. Click Down arrow to reveal the SiteService selector. Options include:

  • Source — Options include <Self> or Screen (default):
    • <Self> — Select <Self> to explicitly configure the SiteService for this control or screen element. A SiteService selector is displayed:
      • SiteService — The SiteService property specifies the SiteService for which the control (or screen or screen element) is to display data. Click Open dialog box to select a service using the Select Service dialog box.
    • Screen — Select Screen to receive the SiteService from the screen for this control or screen element. By default, the sender is the Screen control if no other senders have been configured.
LegendBack to top

Legend date format

LegendDateFormat

The Legend date format property specifies the format for the dates used in the chart legend. Use this property to override the Default date format, which is configured in the Application settings page of the Backstage view. The default date format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2024/01/01 10:20:30.0001.

Legend format

LegendFormat

The Legend format property specifies the format for the text used in the chart legend. The text can display a static text string, such as a label, legend, tooltip, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value. Click Open dialog box to configure the static text and/or property tokens using the CygNet Property String dialog box. The default format is %SiteService%:%PointIdLong%. For example, CYGDEMO.UIS: <FACILITY_UDC>.

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

Thin Web Client

This is the only chart legend property supported by TWC. If configured (to use a dynamic text string), or left empty (to use the series Name), the other legend properties will apply their default values: Legend date format: YYYY/MM/DD HH:MM:SS.fff; Legend location: bottom; Legend value format: #,##0.00; and Show legend: Yes.

Legend location

LegendLocation

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

Legend value format

LegendValueFormat

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 default value format is #,##0.00, which corresponds to 123,456,789.12. Formats use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. Add additional zeros to show more decimal places.

Show legend

IsLegendVisible

The Show legend check box indicates whether to display the legend on the chart. The default option is to show the legend.

ToolbarBack to top

Toolbar items

ToolBarItems

The ToolBar items configuration box contains the properties required to configure the buttons that will appear on the chart's toolbar in run mode. Buttons include several functional Toolbar buttons (live update, date range configuration, save, open, print, export, and reset zoom) and any number of customizable Quick range buttons, which are used to view predefined ranges of time only visible for the current runtime session. The number of defined toolbar items is listed on the property label. All buttons are displayed by default if the toolbar is set to visible.

Canvas - Chart toolbar buttons in run mode

Canvas Native view
Sample chart toolbar buttons in run mode.
The buttons appear in the following order: Live update toggle pair,
Date range, Quick range buttons, Save, Open,
Print, Export as image, Export to CVS, and Reset.

 

TWC - Chart toolbar buttons in run mode

CygNet TWC web view
Sample chart toolbar buttons in run mode.
The buttons appear in the following order: Live update toggle pair,
Date range, Print, Export as image, Export to CVS, and Quick range buttons.
The Save, Open, and Reset buttons are
Not supported by TWC.

See Using a Chart in Run Mode for a description of the chart toolbar icons.

Toolbar buttons property group

The Toolbar buttons property group contains properties used to show or hide the buttons that will appear on the chart's toolbar in run mode. Click the check box next to the items you want to show in run mode.

The first set of check boxes indicate the buttons that are supported only in the Canvas Native view only. The Native and Web supported check boxes indicate the buttons that are supported in screens created for both the Canvas Native view and the CygNet TWC web view.

Click Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

 

Chart toolbar buttons configuration

Chart toolbar buttons configuration

Show save and open buttons

ToolBarSaveOpenOptionVisible

Not supported by TWC The Show save and open buttons check box indicates whether to display a Save currently selected screen (Save the chart's configuration to a file) button and a Open an existing screen (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.

Show reset zoom button

ToolBarResetVisible

Not supported by TWC The Show reset zoom button check box indicates whether to display a Reset to unzoomed state (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.

Native and TWC supported toolbar buttons

The next set of check boxes show buttons that are supported both in the Canvas Native view and in the CygNet TWC web view .

Show live update button

ToolBarLiveUpdateVisible

The Show live update button check box indicates whether to display the Disable live updates for this chartEnable live updates for this chart (Disable live updates / Enable live updates) toggle buttons on the chart's toolbar in run mode. These buttons allow 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.

Show date range button

ToolBarDateConfigOptionVisible

The Show date range button check box indicates whether to display a Configure date range (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.

Show print button

ToolBarPrintVisible

The Show print button check box indicates whether to display a Print current view (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.

Show export buttons

ToolBarExportVisible

The Show export buttons check box indicates whether to display a Export as image (Export as image) button and a Export data to CSV (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.

Quick range buttons property group

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. There is no limit to the number of quick range buttons you can configure.

Click Down arrow in circle to expand each property group as necessary. Click Up arrow in circle to collapse each property group as necessary.

In the Quick range buttons section, do the following:

  1. Click Show quick range buttons to display the buttons in run mode.
  2. Click Add button to add a quick range button to the toolbar.
  3. Configure the Label, Size, Units, and Tooltip for each button. The properties are described below.
  4. Or click Delete relative range(Delete quick range button) to remove a button from the chart's toolbar as necessary.

 

Chart quick range buttons configuration

Chart quick range buttons configuration

Show quick range buttons

ToolBarQuickRangeButtonsVisible

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.

Units

 

The Units property specifies the time unit for the range associated with the quick range button. The options include: Seconds, Minutes, Hours, Days, and Years. The default value is Seconds.

Size

 

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.

Label

 

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

Tooltip

 

The Tooltip property specifies the tooltip to be displayed under the quick range button.

Toolbar location

ToolBarPosition

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

Note: The Toolbar location property is Not supported by TWC. The default location in the TWC view is at the top of the chart.

Toolbar visible

ToolBarVisible

The Toolbar visible check box indicates whether the toolbar is visible on the chart. The default value is hidden.

Zooming and PanningBack to top

Drag mode

DragMode

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

Pan mode

PanMode

PanOffset

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

Zoom mode

ZoomMode

Zoom

Not supported by TWC The Zoom mode property allows users to zoom in to the chart plot area when there is a dense area of data points that cannot be seen clearly at the normal chart scale. With Zoom enabled you start dragging on the plot area, a gray zoom rectangle will be created and when the mouse is released the visible area will fit into the rectangle. Options include:

  • None — Zooming with the mouse is disabled.
  • Horizontal — Zooming with the mouse is enabled only on the horizontal axis.
  • Vertical —Zooming with the mouse is enabled only on the vertical axis.
  • Both — Zooming 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 zoomed in both the horizontal and vertical axes.

The default value is None.

See Zoom Changed for related event.

GenericBack to top

String

String

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

Yes/No

YesNo

Not supported by TWC The Yes/No property specifies a generic Boolean yes/no property that can be used when scripting this control. Click the check box to enable the property and reference it in your script as necessary.