Panel Name |
fwTrendingPlotsPage.pnl |
|
Introduction |
This panel is used to create or modify Trending Pages. A Trending Page is a collection of Trending Plots. It is possible to add up to 6 plots on a page (2 columns and 3 rows). The user may only add pre-existing plots to a page. |
|
Instructions | When creating a new page, you should first enter a Page Name and Page Title in the corresponding fields. The Page Name will be used as the data point name of the page configuration. This is the name used to refer to the page configuration in CTRL scripts. The Page Title is intended to be a more descriptive text which explains the data shown or the purpose of the page. The Page Title can be useful to help identify which page is which when browsing through lists of pages. Then, select the desired number of Columns and Rows of plots you wish to display on your page. Once you have done this, you should see the desired number of boxes appear in the space below. To assign a plot to a position on the page, click the button marked "..." in the box that is in the relevant position. This will load a panel which displays all the current plots which you can add to this page. Once you have selected the plot to use, you will see a symbolic representation of the plot appear in the chosen position on the page. This symbol shows the name of the plot as well as the foreground and background colours of the plot. You can change a plot for another plot by clicking on the relevant "..." button. Also, if a plot requires template parameters, you will be given an opportunity to set these when adding the plot to the page. To modify the values set for the template parameters, you can click on the "{a}" button. This button is only available for plots which actually use template parameters. You do not need to fill every position in the page with a plot. Once you have filled all the required positions on the page, you should save the page by clicking OK or Apply. Clicking Cancel will close the panel without saving the page. The Save as... button can be used to save the displayed page configuration to another data point. If you are modifying an existing page, you will have all the options as above except that the Page Name will not be modifyable. If you wish, you can use a template parameter in the Page Title. 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 Page Name is used as the data point name of the Page. 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 Page to edit. If creating a new page, 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 page data point. Pressing OK or Apply saves the new configuration to the given data point. The page dp name field is editable. "edit" - for editing an existing page data point. Pressing OK or Apply saves the new configuration to the given data point. The page dp name field is not editable. "onlineedit" - used from the page display panel to modify the configuration without modifying the data point. Pressing OK returns the new page configuration to the panel from which it was opened. The page 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.