Value Box Control (version 24)

Knowledge Base / Version 24 / Client Tools / Axiom / Applications

updated 5 mths ago

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
FontSize - Small, Normal, Large, Extra Large
HorizontalAlignment - sets the horizontal alignment of the text within the control: Left, Center, Right
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
ValueFormat - determines how the value should be formatted. The user can choose to display the Value, Time, or Quality of a tag within the value box by using the respective keyword. For more information on how to format value boxes, see Value Box Formatting Options.
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 value box is clicked
*OnEndValueChange - used to trigger a script that runs immediately after the tag value changes