Panel Name |
fwTrendingSetTemplateParameters.pnl |
|
Introduction |
This panel is used to set the template parameters required for the display of a Trending Page of Trending Plot. |
|
Instructions | When the panel loads, you will be presented with a table that shows all the template parameters required by the Plot or Page. In the "Value" column of the table, any previously defined values for the template parameters will be shown. To set the value of a template parameter you can either: 1) Click in the "DP" column on the "..." of the relevant table row to open a data point selector to choose a data point name that will substituted for the template parameter. 2) Click in the right hand "Value" column of the relevant table row and type the desired value for the template parameter. Once you have entered all the values you require to set, press the OK button to set the new values. If you wish to not change the current settings, press the Cancel button. In some situations, there is a "Leave Undefined" button available. This can be used to set all the template parameters to undefined. This removes any previously configured value for the parameters. |
|
Restrictions | None |
![]() |
Dollar Parameters | ||
Name | Description | |
$requiredParameters | A dyn_string containing a list of template parameters which are required to be gathered. These appear in the "Template Parameter" column of the table. | Required |
$templateParameters | A string containing any current definitions of template parameters. If a template parameter is defined in this list and appears in $requiredParameters, then its value will be shown in the "Value" column of the table. The string must be in the standard format for template parameters, e.g. a=1,b=2,param=value, |
Required |
$mode | The mode is a string which can be set to either "set" or anything else. In "set" mode, the values left undefined (i.e. {a} in the "Value" column) are not returned when the user presses OK. Only the parameters which have values that do not begin with { and end with } will be returned. In the other mode, all values are returned exactly as written in the "Value" column. So if a user leaves {a} in the column and presses OK, this is assumed to be the required value for this template parameter. |
Required |