Click or drag to resize

ControlTrendCalculation Class

Trend that uses equation to calculate its output given data from other trends in a given ControlTrendGraph. Requires parent of type ControlTrendGraph.
Inheritance Hierarchy
SystemObject
  AxiomCore2.ControlsControlBase
    AxiomCore2.ControlsControlTrendCalculation

Namespace: AxiomCore2.Controls
Assembly: Canary.Axiom.Session (in Canary.Axiom.Session.exe) Version: 25.6.0.25344+3070493948bf7d32a86bd3e9a8bcf4cc9a5b1929
Syntax
C#
Copy
public sealed class ControlTrendCalculation : ControlBase, 
	IControlBase, IDisposable

The ControlTrendCalculation type exposes the following members.

Properties
 NameDescription
Public propertyBandHeight Height of band. When not null, value must be equal to or between 0.0 and 1.0. 1.0 is height of plot area. Default value is null.
Public propertyBandStart Position of band start. When not null, value must be equal to or between 0.0 and 1.0. 0.0 is top of plot area. 1.0 is bottom of plot area. Default value is null.
Public propertyColor Color of control. Default value is Color.Empty.
Public propertyDisplayName Shortened readable name given to a trend that is unique within the TrendGraph parent.
Public propertyDrawingMode Used to determine how trend should be drawn.
Public propertyDrawingStates A collection of different drawing states used when drawing mode is set to "State".
Public propertyEquation Equation that can be used to generate output using data from other trends in a given ControlTrendGraph.
Public propertyFloatLabelX X position of float label as a ratio equal to or between 0.0 and 1.0. 0.0 represents the left edge of the plot area. 1.0 represents the right edge of the plot area.
Public propertyFloatLabelY Y position of float label as a ratio equal to or between 0.0 and 1.0. 0.0 represents the top edge of the plot area. 1.0 represents the bottom edge of the plot area.
Public propertyIsFloatLabelVisible Determines visibility of float label. Default value is false.
Public propertyIsHorizontalGridVisible Determines if horizontal grid lines should be drawn at trend tick marks. Default value is true.
Public propertyIsLimitHighFillEnabled Determines if high limit will be drawn as fill.
Public propertyIsLimitHighLineEnabled Determines if high limit will be drawn as line.
Public propertyIsLimitLineVisibleOutOfBand Determines if limits should be drawn outside if they are outside of the trends defined scale range. Default value is true.
Public propertyIsLimitLowFillEnabled Determines if low limit will be drawn as fill.
Public propertyIsLimitLowLineEnabled Determines if low limit will be drawn as line.
Public propertyIsScaleLeftVisible Determines if left scale is visible. Default value is true.
Public propertyIsScaleLogarithmic Determines if scale is logarithmic. Default value is false.
Public propertyIsScaleRightVisible Determines if right scale is visible. Default value is true.
Public propertyIsVisible Visibility of control. Default value is true.
Public propertyKind Kind of control.
(Inherited from ControlBase)
Public propertyLimitHighFillColor High limit fill color.
Public propertyLimitHighLineColor High limit line color.
Public propertyLimitHighSourceTag High limit dynamic value. Expected value is DisplayName of another trend that will be used as high limit. Default value is null.
Public propertyLimitHighValue High limit fixed value. Default value is null.
Public propertyLimitLines Array of fixed limit lines that may be used as reference points.
Public propertyLimitLowFillColor Low limit fill color.
Public propertyLimitLowLineColor Low limit line color.
Public propertyLimitLowSourceTag Low limit dynamic value. Expected value is DisplayName of another trend that will be used as high limit. Default value is null.
Public propertyLimitLowValue Low limit fixed value. Default value is null.
Public propertyLineThickness Line thickness of the trend drawn in plot area in pixels.
Public propertyLinkBand Determines if a band is linked to another trend band. Expected value is the DisplayName of the trend to link to. Be careful that a circular reference is not created. Default value is null.
Public propertyLinkScale Determines if a band is linked to another trend band. Expected value is the DisplayName of the trend to link to. Be careful that a circular reference is not created. Default value is null.
Public propertyName Control name that is unique within the owning screen. Name of control must conform to the regex pattern [a-zA-Z0-9], as only letters and numbers are valid characters.
(Inherited from ControlBase)
Public propertyNumberFormatDigits Number of digits used to format value. Range of 0 to 20
Public propertyNumberFormatMode Determines how numbers are formated for the trend. Default value is Decimal.
Public propertyParent Parent of the control.
(Inherited from ControlBase)
Public propertyScaleMax High scale value. High scale is automatically calculated when null. Default value is null.
Public propertyScaleMin Low scale value. Low scale is automatically calculated when null. Default value is null.
Public propertyScaleMode Determines if scale range is auto or fixed.
Public propertyScreen Screen the control resides in.
(Inherited from ControlBase)
Public propertyTemplateId Id used to find sibling controls within a template. All siblings will have the same id. Default value is null.
(Inherited from ControlBase)
Top
Methods
 NameDescription
Public methodAncestorsT Get ancestor controls that implement generic control interface defined by T.
(Inherited from ControlBase)
Top
See Also