Panel Name |
fwTrendingHistogramConfig.pnl |
|
Introduction |
This panel is used to create or modify Trending Plots of type Histogram. |
|
Instructions | When creating a new histogram, you should first enter a Plot Name and Plot Title in the corresponding fields. Then you specify the general characteristics of the plot, such as the foreground and background colours. There are also settings to choose if you want to show the default PVSS legend (not selected by default) and have a grid to help read the histogram. Next you configure which data to show in the histogram. To do this, you first enter the data point element to be plotted. The data source data point element must be of dyn_var type and the variable type must be numerical (e.g. dyn_float). You can type this manually in the first column or choose it from the data point selector by pressing the "..." button. Once you have chosen a data point element, the "Legend Text" column will automatically be filled in with a text. You can change this text as you wish. After this you can set some parameters such as colour and Y axis range. To choose a curve colour you should press the coloured square and a colour picker will appear. You can set automatic scaling (by checking the "Auto" checkbox) or manually selected min and max axis limits. Once you have filled all the required configuration for the histogram, you should save the plot by clicking OK or Apply. Clicking Cancel will close the panel without saving the histogram. The Save as... button can be used to save the displayed histogram configuration to another data point. If you are modifying an existing histogram, you will have all the options as above except that the Plot Name will not be modifiable. If you wish, you can use a template parameter in the Plot Title, Data Source DP Element and Legend Text. A template parameter is defined by placing the variable name between curly brackets, { }. So the Plot Title could be HVChannels{myVariable}. Where {myVariable} is substituted by another value at a later time. |
|
Restrictions | The Plot Name is used as the data point name of the Plot.
As this is the case, it must not include any characters not allowed in
PVSS data point names. |
![]() |
Dollar Parameters | ||
Name | Description | |
$sDpName | Data point name of the Plot to edit. If creating a new plot, set this value to an empty string. |
Required |
$Command | Mode in which the panel is to run. The keyword to pass should be one of the following: "new" - for creating a new plot data point. Pressing OK or Apply saves the new configuration to the given data point. The plot dp name field is editable. "edit" - for editing an existing plot data point. Pressing OK or Apply saves the new configuration to the given data point. The plot dp name field is not editable. "onlineedit" - used from the plot display panel to modify the configuration without modifying the data point. Pressing OK returns the new plot configuration to the panel from which it was opened. The plot dp name field is not editable. If this $-parameter is not defined, the panel runs in "edit" mode, unless $sDpName is blank in which case the mode is "new". |
Optional |
$dsShowButtons | Controls which of the OK, Apply and Cancel buttons are shown at runtime. The keywords for the buttons are "ok", "apply" and "cancel". The value passed in the $-parameter should be a dyn_string containing a list of the buttons to show, e.g. makeDynString("ok", "cancel"). The keywords are case insensitive. If this $-parameter is not defined, all three buttons are shown. |
Optional (except when using addSymbol() - see below) |
Note: The optional $-parameters mentioned above must be
passed if you are displaying this panel with the addSymbol() function. If you
do not
pass
all
$-parameters when using addSymbol(), errors will be given in your porject log
and the functionality of the panel may not be as expected.