SetLineVisible Method

SetLineVisible is a method for a Trend Invoke method action.

  • Purpose: SetLineVisible
  • Advanced Configuration: SetLineVisible

Purpose: SetLineVisible

To change one or all lines on the Trend Control visible or invisible.

Advanced Configuration: SetLineVisible

Click Advanced on the Action tab of the Procedure Information dialog box.

The Edit Method dialog box opens for the SetLineVisible 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 line is visible.
0 The line is invisible.
Parameters LineID Identify what line or lines should be automatically updated.
Value Identifies
'''' All the lines.
Existing Line ID A single line.
nOffOnToggle Expression or Point ID that evaluates to the numeric value:
Value Trending will
0 Make selected line(s) invisible.
1 Make selected line(s) visible.
2 Toggle.
Note: When the line is made invisible, it is removed from the chart. If you did not check the Always visible legend option, the line description is also removed from the legend.

Even thought the line is removed from the display, the Trend Control still collects data and performs calculations for the line.