SetLegendState is a method for a Trend Invoke method action.
|
Purpose: SetLegendState |
|
|
Advanced Configuration: SetLegendState |
Purpose: SetLegendState
To change the visibility of the legend for the trend.
Advanced Configuration: WriteReferenceFile
Click Advanced on the Action tab of the Procedure Information dialog box.
The Edit Method dialog box opens for the SetLegendState 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 displays: |
|||||
|
|
|
Value |
Method Result |
|||
|
|
|
1 |
Legend is visible. |
|||
|
|
|
0 |
Legend is invisible. |
|||
|
Parameters |
nOffOnToggle |
Expression or Point ID that evaluates to one of the following numeric values. |
||||
|
|
|
|
Value |
Trending will |
||
|
|
|
|
0 |
Hide the legend. |
||
|
|
|
|
1 |
Show the legend. |
||
|
|
|
|
2 |
Toggle the visibility of the legend. |
||
|
|
|
|
|
|
|
|
|
|
Legend Methods. |
|
|
All Trend methods. |
