Specify any optional YAXIS values after the YAXIS Mandatory Value in a TrendSpec definition. Remember to include a comma at the end of the mandatory value before listing any of these optional values. Include a comma between each optional value’s definition.
Many of the optional YAXIS values are equivalent to the properties that you can specify using the Edit Y Axis window on a Pre-Configured Trend. For further information on these properties, see Add a Y-Axis.
The optional values that you can specify within the YAXIS section are:
|
YAXIS Optional Values |
||
|---|---|---|
|
Identifier |
Value Type |
Comments |
|
Label (Use as an alternative to the YAXIS LabelExpr identifier.) |
String |
Use to define a string for the text that identifies the Trend Y-Axis.
Example:
Label = 'Zone1.Motor2.Running' If you use the % character in the Label, it needs to have a 25 suffix, for example, %25. This is because the percent character requires the 25 escape code when used in URLs. To use an expression to define the value of the y-axis’ label, use the YAXIS LabelExpr identifier instead of this Label identifier. |
|
LabelExpr (Use as an alternative to the YAXIS Label identifier.) |
String |
Use to define an expression for the text that identifies the Trend Y-Axis.
Example:
LabelExpr = '""Main:Zone1.Sensor1.AlarmState""' To specify a string, rather than an expression, use the YAXIS Label identifier instead of this LabelExpr identifier. |
|
LabelPos |
Identifier value |
Use to specify the position of the y-axis’ label. Specify one of these values: Top, Centre, or Bottom.
Example:
LabelPos = Top Alsosee Use TrendSpec to Define an Ad Hoc Trend’s Text Attributes. |
|
LabelStyle |
Identifier value |
Use to specify the orientation of the y-axis’ label. Specify one of these values: Normal, or Rotated.
Example:
LabelStyle = Normal Alsosee Use TrendSpec to Define an Ad Hoc Trend’s Text Attributes. |
|
Position |
Identifier value |
Use to specify the position of the y-axis on the ad hoc Trend. Specify one of these values: Left, or Right.
Example:
Position = Left Alsosee Use TrendSpec to Define a Multiple Trace Ad Hoc Trend. |
|
Visible |
Boolean |
Use to specify whether the Trend Y-Axis is shown on an ad hoc Trend. (You have to include one YAXIS section per trace in your TrendSpec definition, regardless of whether that y-axis is shown on the Trend.)
Example:
Visible = True The value of this identifier is ignored if the TREND section includes a ShowYAxes identifier. |
|
Format (Only applicable when the YAXIS section of a definition does not include a States identifier.) |
String |
Use to specify the format of the values that are displayed on the y-axis. To display a specific number of digits, enter a 0 for each digit that is required. The digit will still be displayed, even if it is zero. To suppress a digit when it is zero, enter the code %23 for each such digit. The digit will only be displayed when it is non-zero.
Example:
Format = '0.0%23%23%23%23' (To display a single decimal place, regardless of whether it is zero. Further decimal places (up to five in total) are displayed only when they are non-zero.) For other syntax supported by the Format identifier, see Numeric Syntax. |
|
ScaleType |
Identifier value |
Use to specify how the y-axis is scaled. Specify one of these values: Manual, Range, or Automatic.
Example:
ScaleType = Range If the ScaleType is Manual, include the Minimum and Maximum identifiers in the YAXIS section of the definition. If the YAXIS section includes the States identifier, set the ScaleType to Range. |
|
Logarithmic |
Boolean |
Use to specify whether the y-axis is scaled using a base-10 logarithm.
Example:
Logarithmic = False |
|
Minimum (Only applicable if the ScaleType is Manual.) |
Real |
Use to specify the lowest value that is to appear on the y-axis.
Example:
Minimum = 0.000000 Alsosee Enable Users to Specify Which Traces to Include on an Ad Hoc Trend. |
|
Maximum (Only applicable if the ScaleType is Manual.) |
Real |
Use to specify the largest value that is to appear on the y-axis.
Example:
Maximum = 100.000000 Alsosee Use TrendSpec to Produce a Trace that has Multiple Data Sources. |
|
Invert |
Boolean |
Use to specify whether the y-axis’ values are to be inverted.
Example:
Invert = False Alsosee Enable Users to Specify Which Traces to Include on an Ad Hoc Trend. |
|
AutoTicks (Only applicable when the YAXIS section of a definition does not include a States identifier.) |
Boolean |
Use to specify whether ClearSCADA is to allocate the y-axis’ major and minor ticks automatically.
Example:
AutoTicks = True If AutoTicks = False, include the MajorTicks and MinorTicks identifiers in the YAXIS section of the definition. |
|
MajorTicks (Only applicable if AutoTicks is False and no States identifier is specified.) |
Integer |
Use to specify the number of major tick indicators that are to be shown on the y-axis. Specify a suitable whole number in the range 2 to 100 inclusive.
Example:
MajorTicks = 11 |
|
MinorTicks (Only applicable if AutoTicks is False and no States identifier is specified.) |
Integer |
Use to specify the number of minor tick indicators that are to be shown in between the y-axis’ MajorTicks. Specify a whole number between 0 and 10 inclusive.
Example:
MinorTicks = 1 |
|
States |
String |
Use the States identifier to associate the data source’s state descriptions with the ticks on the y-axis.
Example:
States = 'Eastern Region.Switch2' |
|
ShowGrid |
Boolean |
Use to specify whether horizontal grid lines are shown for the ticks on the y-axis.
Example:
ShowGrid = False Alsosee Enable Users to Specify Which Traces to Include on an Ad Hoc Trend. (Use the XAXIS ShowGrid identifier to specify whether vertical grid lines are displayed (see XAXIS Optional Values).) |
|
Colour |
RGB |
Use to specify the RGB color of the y-axis.
Example:
Colour = RGB(0,0,0) |
|
StateSystem (Only required if the States identifier is specified and there are see Multiple Databases) |
String |
Use to specify the ClearSCADA database from which the States identifier’s source is obtained.
Example:
StateSystem = 'Main' |