Linear Gauge Control (version 24)

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 gauge
• Display - provides 3 different options for displaying the gauge: Standard, Fill, Cutaway
• Height - the height of the control in pixels
• IsLimitRangeVisible - a checkbox to show/hide limit(s) if configured. If enabled, the gauge will change color when a limit is exceeded.
• 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
• MajorInterval - sets how often a major tick should appear on the scale
• Orientation - determines how the gauge will be oriented: Horizontal, Vertical, or Automatic. If Automatic is selected, the gauge will adjust as the control is resized.
• ScaleMax - the maximum value the gauge reaches
• ScaleMin - the minimum value the gauge starts at
• 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 gauge is clicked
• *OnEndValueChange - used to trigger a script that runs immediately after the tag value changes

* These properties are only available to Canary users listed on the Axiom>Script access control list within the Identity tile.