SetLineUseChartY Method
SetLineUseChartY is a method for a Trend Invoke method action.
- Purpose: SetLineUseChartY
- Advanced Configuration: SetLineUseChartY
Purpose: SetLineUseChartY
To change the line's Y-axis to either the Chart Y Axis or an axis whose ID is the line's ID plus a _Y suffix.
Advanced Configuration: SetLineUseChartY
Click Advanced on the Action tab of the Procedure Information dialog box.
The Edit Method dialog box opens for the SetLineUseChartY method
Configuration is as follows.
Field | Description | |||||
---|---|---|---|---|---|---|
Method name | Name of the selected method. Note: Another method can be selected from the drop-down list. | |||||
Method result | (Optional) Setpoint that contains the status value. | |||||
Class | Boolean | |||||
Structure Type | BOOL | |||||
Allowed | Device or global Point ID. | |||||
When a user invokes the method, the method result contains one of the following values. | ||||||
Value | Method Result | |||||
1 | The method executed successfully. | |||||
0 | The method failed. | |||||
Parameters | LineID | String that evaluates to an existing Line ID. | ||||
UseChartYAxis | Line or lines whose Chart Y Axis is used/not used. Expression or Point ID that evaluates to the numeric value: | |||||
Value | Trending will | |||||
0 | Not use the Chart Y-axis. | |||||
1 | Use the Chart Y-axis. | |||||
Results depend on whether or not the line was using the Chart Y Axis. | ||||||
Option | Description | |||||
1 | If the line was using the Chart Y Axis and UseChartYAxis is 0, Trending disables the Chart Y-axis and maintains the current settings. | |||||
2 | If the line was not using the Chart Y Axis and UseChartYAxis is 1, the Chart Y Axis is enabled and the current chart axis settings are used. |