WinList allows users to access two types of keywords: FCS keywords stored in data files, and internal keywords that WinList calculates.
Users can access keywords for histogram, MultiGraph, and results window titles, as well as text labels in MultiGraphs. Keywords are identified by surrounding specific words with square brackets [ ]. When WinList sees a keyword, it replaces it with the keyword's value. For example, [DATE] is an internal keyword that would display the current date. [$TOT] is an FCS keyword which tells how many total events were stored in the listmode file. Generally, when the user can edit a text field, keywords are available for those fields.
WinList also supports mixed text and keywords. It is possible, therefore, to display a label for a MultiGraph that would display the date and time as follows:
Date: [DATE] Time: [TIME]
In this example, if the current date is 01-Mar-2013 and the time is 09:20:45, WinList would display:
Date: 01-Mar-2013 Time: 09:20:45
The internal keywords supported by WinList are listed below.
[DATE]: Displays the current system date reported by your computer.
[TIME]: Displays the current system time reported by your computer.
[FILE]: Displays the filename of the active data source.
[FILE,dsID]: Displays the filename of the data source with an ID of dsID.
[FILEROOT]: Displays the base of the active data source file name. For example, if the file name is 190594.FCS, the FILEROOT keyword returns 190594, leaving off the file extension.
[FILEROOT,dsID]: Displays the base of the filename for the data source with an ID of dsID..
[FILEPATH]: Displays the pathway to the active data source file.
[FILEPATH,dsID]: Displays the pathway for the data source with an ID of dsID.
[DEFAULTPATH]: Displays the pathway to protocols and other WinList file types.
[HISTOGRAM]: Displays the name of the active histogram.
[GATE]: Displays gate information of the active histogram.
[COUNTERn]: Displays the current value of user-programmable counter n. This value can be changed with macro commands ModifyUserCounter and ResetUserCounter. See Edit Macro and Macro Commands for more on changing the counter's value.
[LEVEL]: Returns the level of the current batch item.
[NEXTLEVEL]: Returns the level of the next batch item.
[FINISHBATCH]: Returns 1 if the last batch item has been processed.
[NEWLEVEL]: Returns 1 if the next batch item level is different from the current level.
[BATCHINDEX]: Returns the index of the current file in the batch list.
There are two forms of the following keyword, used to display a region result. Note that no spaces are permitted in the keyword syntax below.
[R(n,stat)]: Displays a statistic stat for region n, where
n is the number of the region, and
stat is the textual name of the statistic as shown in the table below.
[R(n,PCN,g)]: Displays the percent-of-gate statistic for region n and gate g, where
n is the number of the region, and
PCN is a literal that specifies the Percent of Gate N statistic, and
g is the gate ID of for the gate of interest.
To display |
stat equals |
or |
Total events |
TOTALEVENTS |
TOT |
Gated events |
GATEDEVENTS |
GAT |
Region events |
REGIONEVENTS |
REG |
Percent Total |
PERCENT |
PCT |
Percent Gated |
PERCENTGATED |
PCG |
Name of the gate applied to the histogram containing region n |
GATENAME |
GTN |
Mean X |
MEANX |
MNX |
Mean Y |
MEANY |
MNY |
Median X |
MEDIANX |
MDX |
Median Y |
MEDIANY |
MDY |
Median X in ADC units |
MEDIANADCX |
MDADCX |
Median Y in ADC units |
MEDIANADCY |
MDADCY |
Mode X |
MODEX |
MOX |
Mode Y |
MODEY |
MOY |
CV X |
CVX |
CVX |
CV Y |
CVY |
CVY |
Standard Deviation X |
STDDEVX |
SDX |
Standard Deviation Y |
STDDEVY |
SDY |
Low X |
LOWX |
LOX |
Low Y |
LOWY |
LOY |
High X |
HIGHX |
HIX |
High Y |
HIGHY |
HIY |
Correlation coefficient. |
CC |
CC |
Data source filename containing the region |
DS |
DS |
Name of the histogram containing the region |
HST |
HST |
For example, to display the percent of gate statistic for region R5, type:
[R(5,PCG)]
To display "percent of gate N" statistic for R6, where gate N is gate 2, type:
[R(6,PCN,2)]
Another group of keywords is used in DDE scripts and is specific to histogram windows. These keywords can be put into script statements and surrounded by curly brackets { }. WinList will replace them with histogram-specific information before sending the DDE command to the remote application.
For example, to pass the parameter names of a two-parameter dot plot to IsoContour, you can enter [SetLabelText('3,{XNAME} -->')]. The portion of the command in curly brackets, XNAME, will be replaced with the name of the parameter on the X-axis, then the command will be sent to IsoContour.
DDE keywords are listed below:
For Histograms:
{XNAME} displays the name of the X parameter (1st parameter) in a histogram
{YNAME} displays the name of the Y parameter (2nd parameter) in a histogram
{ZNAME} displays the name of the Z parameter (3rd parameter) in a histogram