The Value Indicator 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.
You can click
(Categorize), click
(Alphabetical within Category) or click
(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
or
next to the group name or simply clicking anywhere in the category heading.
The following tables describe 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 | ||
|
ControlName |
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. |
|
|
ControlType |
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 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.
Styles are created in two ways:
Tip: You can also change a control's Style on the Controls view of the Screen pane. |
|
| Location |
||
|
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 |
|
|
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:
The default value is None. |
|
|
Layer |
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.
Tip: You can also edit a control's Layer on the Controls view of the Screen pane.
|
|
|
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:
The default value is None. |
|
|
IsVisible |
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 |
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
| Script |
||
|
|
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. |
|
| Font |
||
|
TextStyle |
The Text style property specifies the style to use for the text that appears on the control. Options include: Normal, Italic, or Oblique. The default value is Normal. |
|
|
TextWeight |
The Text weight property specifies the weight to use for the text that appears on the control. Options are: Normal or Bold. The default value is Normal. |
|
| Tooltip |
||
|
TooltipText |
The Tooltip property specifies the text that will appear on the control's tooltip, which can be a static label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. Click |
|
|
TooltipEnabled TooltipDuration TooltipBetweenShowDelay ToolipInitialShowDelay |
The Tooltip enabled property indicates whether to display a tooltip when the mouse hovers over the control. |
|
|
TooltipMode |
The Tooltip mode property specifies how the tool will be displayed. Options include:
The default value is Text. |
|
|
TooltipObjectPath TooltipObjectSource |
The Tooltip object path property specifies the path used for the tooltip when Object mode is selected. Click |
|
| Display |
||
|
FontSize |
The Font size property specifies the font size of the text on the control. |
|
|
Text |
The Text property specifies the text that will appear on the face of the control, which can be a static label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. Click |
|
| Value |
||
|
IsAnimated |
The Animate Marker check box indicates whether to animate the marker movement. When enabled the Value Indicator's marker will move smoothly from one value to the next value. |
|
|
ColorConfiguration |
The Color configuration box contains all the options required to specify the color properties of the control. Click |
|
|
ColorConfiguration.BackgroundSource ColorConfiguration.BackgroundSelfColor |
The Background color property specifies the color used for the background of the control. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State). Options include:
Note: You can override the default point state colors for this element by creating a custom color palette. See Configuring Color Palettes and Color palette for a screen or object for more information. |
|
|
ColorConfiguration.TextColorSource ColorConfiguration.TextSelfColor |
The Text color property specifies the color used for the text of the control. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State). Options include:
Note: You can override the default point state colors for this element by creating a custom color palette. See Configuring Color Palettes and Color palette for a screen or object for more information. |
|
|
ColorConfiguration.MarkerBorderColorSource ColorConfiguration.MarkerBorderSelfColor |
The Marker border color property specifies the color used for the border of the triangular marker in the value indicator. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State). Options include:
Note: You can override the default point state colors for this element by creating a custom color palette. See Configuring Color Palettes and Color palette for a screen or object for more information. |
|
|
ColorConfiguration.MarkerFillColorSource ColorConfiguration.MarkerFillSelfColor |
The Marker fill color property specifies the color used for the interior of the triangular marker in the value indicator. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State). Options include:
Note: You can override the default point state colors for this element by creating a custom color palette. See Configuring Color Palettes and Color palette for a screen or object for more information. |
|
|
ColorConfiguration.UseRangeColor |
The Use point state color? check box indicates whether to use the point state color for the alarm limit range. The default point state colors for a CygNet system are defined by the system’s point scheme. |
|
|
DateTimeFormat |
The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to a point's Timestamp, Last Verified Change Timestamp, and Last Questionable Change Timestamp properties. Use this property to override the default format, which is configured on the Settings page of the Backstage view. The default format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2019/01/01 10:20:30.0001. All timestamps are local client time. Note: You can also use the Microsoft .NET Standard Date and Time Format Strings to define the text representation of a date and time value in Canvas. For example, "d" is the short date pattern and corresponds to 1/1/2019, "F" is the full date/time pattern and corresponds to Monday, January 1, 2019 1:45:30 PM. |
|
|
HideInvalidTag |
The Hide invalid tag check box indicates whether to hide the control if it resolves to an invalid or unknown tag. |
|
|
PointConfiguration |
The Point configuration property is used to configure the CygNet point associated with the control. Click |
|
|
PointConfiguration.SelectionMode |
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:
Sending and receiving facility tagsSome controls on the same screen allow for the sending of facility tag information from one control to another.
|
|
|
Point configuration: Facility tag Point configuration: Facility
|
FacilityID FacilitySender FacilityTag FacilityTag.FacilityId FacilityTag.Service FacilityTag.Site FacilityTag.SiteService FacilityTag.SiteService.Service FacilityTag.SiteService.Site IsRelativeFacilityResolutionEnabled PointConfiguration.Facility PointConfiguration.Facility.FacilityID PointConfiguration.Facility.IsBroadcastSourced PointConfiguration.Facility.IsOrderInType PointConfiguration.Facility.IsOrderInTypeAttributeConfigured PointConfiguration.Facility.IsRelative PointConfiguration.Facility.IsSelfSourced PointConfiguration.Facility.OrderInType PointConfiguration.Facility.RelativeFacilityLink PointConfiguration.Facility.ResolveRelativeFacility PointConfiguration.Facility.Source PointConfiguration.Facility.SourceFacilityID PointConfiguration.FacilityTag PointConfiguration.FacilityTag.FacilityId PointConfiguration.FacilityTag.Service PointConfiguration.FacilityTag.Site PointConfiguration.FacilityTag.SiteService PointConfiguration.FacilityTag.SiteService.Service PointConfiguration.FacilityTag.SiteService.Site PointConfiguration.SourceFacilityTag PointConfiguration.SourceFacilityTag.FacilityId PointConfiguration.SourceFacilityTag.Service PointConfiguration.SourceFacilityTag.Site PointConfiguration.SourceFacilityTag.SiteService PointConfiguration.SourceFacilityTag.SiteService.Service PointConfiguration.SourceFacilityTag.SiteService.Site PointConfiguration.SourceFacilityTagString |
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
|
|
PointConfiguration.SiteService PointConfiguration.SiteService.DisplayString PointConfiguration.SiteService.DomainSiteService PointConfiguration.SiteService.DomainSiteService.DomainId PointConfiguration.SiteService.DomainSiteService.Service PointConfiguration.SiteService.DomainSiteService.Site PointConfiguration.SiteService.DomainSiteService.SiteService PointConfiguration.SiteService.DomainSiteService.SiteService.Service PointConfiguration.SiteService.DomainSiteService.SiteService.Site PointConfiguration.SiteService.IsBroadcastSourced PointConfiguration.SiteService.IsSelfSourced PointConfiguration.SiteService.SiteService PointConfiguration.SiteService.SiteService.Service PointConfiguration.SiteService.SiteService.Site PointConfiguration.SiteService.Source 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 inherited from another control on the same screen, or from the screen, or from another screen. Click
|
|
|
LongPointID PointConfiguration.LongPointID PointConfiguration.PointSelectionMode PointConfiguration.PointTag PointConfiguration.UDC Points Points.Comparer Points.Count Points.Keys Points.Subscribe Points.Unsubscribe Points.Values PointTag UDC |
The Point property is used to determine how the CygNet point will be configured. Click the appropriate radio button to reveal the desired field.
|
|
|
ShowContextMenu |
The Show context menu check box indicates whether a right-click context menu will be available or suppressed in run mode. The default context menu will allow alarm acknowledgment, access to point history and alarm history, point configuration, and facility configuration. |
|
|
ValueFormat |
The Value format property specifies the format for the point's 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. |
|
| Bounds |
||
|
ValueBoundsConfiguration |
The Value bounds configuration box contains all the options required to specify the lower and upper bound of the control. The source of the bounds can be either hard-coded to an explicit value (<Self>), or dynamically determined for each facility by sourcing the value from an application-specific attribute of the associated point (Point Attribute and then selecting an Indexed field or a General data field). A control on a templated screen supports different bounds for each source facility. By using a point attribute to store the bounds (for example, Indexed 1 for the lower value bound and Indexed 2 for the upper value bound), you can have a templated screen without having to script the control. Click CygNet Help: For more information about configuring point application properties, see the Points section in the CygNet Help:
|
|
|
Lower value bound |
ValueBoundsConfiguration.LowerBoundPropertyId ValueBoundsConfiguration.LowerValueBound ValueBoundsConfiguration.LowerValueBoundSet ValueBoundsConfiguration.LowerValueBoundSource |
The Lower value bound property specifies the lower value to use when filling the control. The value bound can be explicitly configured (by selecting <Self>) or the value can be sourced from an application-specific attribute of the associated point (by selecting Point Attribute). Point application attributes are configured on the Application page of the CygNet PNT Editor. The following fields are available to store an attribute that can be used to indicate the value bound.
Options include:
|
|
Upper value bound |
ValueBoundsConfiguration.UpperBoundPropertyId ValueBoundsConfiguration.UpperValueBound ValueBoundsConfiguration.UpperValueBoundSet ValueBoundsConfiguration.UpperValueBoundSource |
The Upper value bound property specifies the upper value to use when filling the control. The value bound can be explicitly configured (by selecting <Self>) or the value can be sourced from an application-specific attribute of the associated point (by selecting Point Attribute). Point application attributes are configured on the Application page of the CygNet PNT Editor. The following fields are available to store an attribute that can be used to indicate the value bound.
Options include:
|
| Generic |
||
|
String |
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. |
|
|
YesNo |
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. |
|