Symbol Control (version 23)

Properties

• Name - a unique name used to reference the control in script *
• AggregateInterval - the amount of time within each interval over which the data is processed using an 'AggregateKind' (e.g. 15 minutes, 15m, 00:15:00)
• AggregateKind - the aggregate used to process the data over a given 'AggregateInterval'
• AggregateStartTime - retrieves the value at a specific actual or relative time (e.g. now, day + 6h, 6:00 AM)
• SourceTag - opens the 'ADD TRENDS' menu to link the control to a tag
• ValueTransform - transform data using the keyword, "value", as the variable tag within an expression (e.g. 3.14*Pow(value,2)). Calculations are performed using C# NCalc library. For more information on NCalc functions, click here.
• Color - sets the color of the symbol
• FlipHorizontal - reflects the symbol over a horizontal axis
• FlipVertical - reflects the symbol over a vertical axis
• Height - the height of the control in pixels
• IsVisible - a checkbox to show or hide the control
• Limit - used to set a limit(s) on the control
  • Value - sets the limit to a static number or other 'SourceTag'
  • Comparison - choose between <, >, >=, <=, or =
  • Color - sets the color for the configured limit
• Rotate - rotates the symbol by x degrees
• Stretch - determines how the symbol will scale within the control
  • Uniform - the aspect ratio of the symbol does not change as the control is resized
  • Fill - the symbol will stretch to fill the control as it is resized
• SymbolSource - opens the 'SYMBOL PICKER' menu to select a symbol from a given category
• Width - the width of the control in pixels
• X - the horizontal coordinate of the top-left corner in relation to its parent container
• Y - the vertical coordinate of the top-left corner in relation to its parent container
• OnBeginValueChange - used to trigger a script that runs immediately before the tag value changes *
• OnClick - used to trigger a script that runs when the symbol is clicked *
• OnEndValueChange - used to trigger a script that runs immediately after the tag value changes *

* These properties are only available to admin users.