LIST
Jump to navigation
Jump to search
display Midas data as textual list
<file> Name of input file <template> Name of template file Keyword Only Parameters: [AUTOSELECT] - ON,OFF. [DEF=ON] Turn auto highlighting of selections on/off. [CNT] - CLICK,CONT [DEF=CLICK] [CURSOR] - CELL,ROW,COL [DEF=CELL] [HILITE] - BACK,FORE [DEF=BACK] [HCOLOR] - Color name [DEF="THEME"] [MULTI] - FULL,OFF [DEF=OFF] Controls SELECT/DESELECT message data on CTRL and SHIFT selections. ****************************************************************************** ** As of release 2.2.0 LIST is considered to be an "End of Life" primitive. ** ** The LIST primitive is scheduled for replacement by LIST2 in future ** ** releases. Please see nxm/sys/docs/list2migration.txt for details. ** ****************************************************************************** LIST is a NeXtMidas file viewer primitive. It does not currently allow any altering/modification of its input file. The [MULTI=FULL] mode should only be used on small lists. This mode forces the return of all selected and previously selected data in the SELECT message and all previously selected data in the DESELECT message. MOUSE: The CTRL key may be used to perform non-contiguous multiple selection and of the SHIFT key to select a range as of version 1.92. TEMPLATES: LIST's data display layout is defined by sets of keywords in the extended-header of a Midas file designated as a 'template'. TEMPLATE KEYWORDS: A:SECTION==XDATALIST (required) All LIST template keywords MUST fall between the SECTION==XDATALIST and SECTION==END keywords. These keywords exist to define the scope of all keyword searches performed by LIST, and also to identify Midas files as LIST templates. The following keywords make up the 'global' keyword section, i.e. those attributes that affect the display as a whole rather than affecting a single field: A:LABELS==ON (optional - default is ON) Controls display of the column label line, which immediately follows any title line(s). Currently accepted values are ON and OFF. A:GRID==ON (optional - default is ON) Controls display of the grid lines. Currently accepted values are ON and OFF. A:COLLABJUS==CENTER (optional - default is CENTER) Controls justification of column labels. Currently accepted values are RIGHT, LEFT and CENTER. A:INDEX==ON (optional - default is ON) Controls display of the row labels column, which displays ordinal element numbers in a non-scrolling region at the left edge of the screen. Values are ON and OFF. L:FIELDS==2 (required) Specifies the number of FIELD sections contained in the template. This value is generally 1 for Type 1000 and 2000 files, or the number of subrecords/subcomponents to be displayed in Type 3000 and 5000 files. For Type 2000 files, the last FIELD section will be used for each remaining element in each frame. A:COLOR==N A:COLOR==GREEN A:COLOR==FIELDN Specifies the color to be used to display the data in each row. Use COLOR==N, N is a color table index, to set the default display color Use COLOR==GREEN, GREEN is the color string, to set the default display color. Use COLOR==FIELDN to cause the color of each row to be dictated by the color of the LIST FIELD==N. This field should be enumerated and have an associated MCOLORS keyword (see below), or else its corresponding data file values will be used as indices into the color table. The remaining template keywords are used to specify the formatting attributes associated with each displayed field: L:FIELD==1 (required) Marks the start of a group of keywords describing a LIST field. The global FIELDS template keyword defines the number of required FIELD==N sections. These sections must begin with FIELD==1 and continue sequentially to FIELD==FIELDS. LIST FIELD sections are declared in the left-to-right order in which they will be displayed. A:SUBR==IN (required for Type 3000, 5000 files) SUBR is required and used only with Type 3000 and 5000 files. It specifies the name of the subrecord or subcomponent to be associated with the current FIELD (HIN.subr or HIN.comp). A:LABEL==IN (optional) Specifies the text to be displayed in the label column for this field. L:WIDTH==19 (required) Specifies the field's display width in characters. Be sure this value is large enough to accommodate the display format defined by DISPFORM (see below). A:DISPFORM==A (optional) Specifies the format pattern used to display this field. See javadocs for java.text.DecimalFormat for correct pattern syntax. A:COLOR==N (optional - default is the specified theme's foreground color) A:COLOR==GREEN A:COLOR==FIELDN Override the default color of the column with a specific color. The easiest ways to specify this color are: (1) Use one of the "defined" colors alone or with one of the following modifiers "DARK,DEEP,LIGHT,BRIGHT". The defined colors are "BLACK,BLUE,CYAN,GRAY,GREEN,MAGENTA,ORANGE,PINK,RED,WHITE,YELLOW". Examples: COLOR==DARKBLUE COLOR==RED (2) Use the hexidecimal representation of the desired RGB color value. Example: COLOR==OXFF0000 (red) COLOR==0X00FF00 (green) COLOR==0X0000FF (blue) Use COLOR==N, where N is a color table index, to set the default display color for this field. Use COLOR==GREEN, where GREEN is the color string, to set the default display color for this field. Use COLOR==FIELDN, to cause the colors of each item in this fieldto mirror those of FIELD==N. Field N should be enumerated and have an associated MCOLORS keyword (see below), or else its corresponding data file values will be used as indices into the color table. A:MENU==One,Two,Three,Four,Five Enumerated list that shows the display values corresponding to the data values in MVALUES keyword. A:MCOLORS==GREEN,BLUE,RED A:MCOLORS==1,2,3 A comma separated list of indices into the color table (or color strings) corresponding to each of the menu items in the MENU keyword. A:MVALUES==4,5,6 A comma separated list of values corresponding to each of the enumerated choices in the MENU keyword. This is the data that is actually stored in the file. L:HIDE==1 (optional - default is 1) Specifies whether or not to hide the column. Currently accepted values are 0 and 1. L:STRETCH==1 (optional - default is 0) Specifies which column to stretch to fill in any unused display area when the LIST window is resized. Only applies to one column at a time. If more than one column is set to STRETCH, the last column specified is the one used. Currently accepted values are 0 and 1. A:COLUMNTYPE==TIME (optional - default is STRING) Currently accepted values are PANEL, TOGGLE, RASTER, TIME, and STRING. If COLUMNTYPE==RASTER, the following fields specify specific attributes for the raster column: L:RASTERFRAME==16 (optional - default is 16) Specifies the width of the raster. L:RASTERLEVELS==16 (optional - default is 16) Specifies the number of color levels in the colormap of the raster. S:RASTERCOLORMAP==RAMP (optional - default is RAMP) Specifies the colormap to use for generating the raster. This is a string argument that can be used to specify one of the defined colormaps (GRAYSCALE,RAMP,WHEEL,TERRAIN,MULTI) or a comma-delimited string of colors that define the colormap itself. S:RASTERSELCOLOR==GREEN (optional - default is GREEN) Specifies the color to use to "highlight" the raster. If COLUMNTYPE==TIME, the following field is used to specify the formatting of the time string: L:TIMEFMT==6 (optional - default is 1 (STD)) Specifies one of the time string formats (as defined in the Time class) in which to display a column of type TIME. Currently accepted values are the numbers 1-7, where 1 - STanDard [yy]yy:mm:dd::hh:mm:ss 1993:02:25::14:42:57.123 2 - ACQisition [yy.ddd]:[hh:mm:ss] 93.056:14:42:57.123 3 - EPOCH quadwords [yy]yy:sec_in_year 1993:4804977.123 4 - NORAD yyddd.frac_of_day 93056.6131611511111111 5 - TimeCode Reader ddd:hh:mm:ss 056:14:42:57.123 6 - VAX dd-MMM-yy[yy]:hh:mm:ss 25-FEB-1993:14:42:57.123 7 - HMS hh:mm:ss 14:42:57.123 Finally, the SECTION==END keyword completes the LIST template: A:SECTION==END (required) Marks the end of the LIST template keywords section NOTE: In normal operations, when using the list command the data from the file being listed is read from the file when the list is drawn for the first time. Therefore, if a list is hidden (such as in a tab), then any updates or additions to that list may be put in the wrong position. As of 2.8.2, the /DRAWHIDDEN switch was added to allow users to 'force' the list to populate with their data, even if it is hidden. This allows for updates and additions to the data to be in the correct position. MESSAGES: PROCESSED: ADDCOLUMN - Adds a column APPLYTEMPLATE - Apply a new template CLOSEFILE - Closes the file COLOR - Sets color CURSOR - Sets highlight color EXIT - Exits the LIST GET - TBD GETROW - Gets a row from the list GETROWVECTOR - Gets a row from the list as a vector GETROWTABLE - Gets a row from the list as a table GETCOL - Gets a col from the list GETCOLUMNVECTOR - Gets a col from the list as a vector GETCOLUMNTABLE - Gets a col from the list as a table HIGHLIGHT - Highlights a given row OPENFILE - Opens a new data file OPENTEMPLATE - Opens a new tamplate OPEN TEMPLATE - DEPRECATED: Use OPENTEMPLATE (no space) OUTPUTTYPE - Sets the default output type (table or vector) PAN - DEPRECATED: This message does nothing. POP - Toggle the push/pop state of the window (Warning: the current implementation of this message is inconsistent with PLOT and LIST2 which check the INFO field to determine type of push/pop. This implementation matches what PLOT and LIST do with INFO=-1.) SET - TBD SETROW - Sets a row in the list REFRESH - Refreshes the list THEME - Sets the theme of the list BUTTON - Internal Message: Mouse click FILES - Internal Message: Show files menu KEYPRESS - Internal Message: Keyboard key press MENU - Internal Message: Show configuration menu OPTIONS - Internal Message: Show options menu OTHER - Internal Message: Show other options menu POINTER - Internal Message: Mouse motion RESIZE - Internal Message: Window resized SETTINGS - Internal Message: Show settings menu WINDOW - Internal Message: Window action SENT: DESELECT - Deselect of selected rows (see SELECT message) SELECT - Selection information Data Fields are: S:TYPE - ROW, COLUMN or CELL O:ROW - Row number (1..n or -1 for COLUMN type) O:COLUMN - Column Number (1..n or -1 for ROW type) T:VALUE - Table of data from last click (LMB, SHIFT-LMB or CTRL-LMB) S:NAME - TBD Optional Data Fields for MULTI=FULL (Version 1.92+) are: T:CURRSEL - Table of CURRENT selected rows data (SELECT msg, ROW type only) T:PREVSEL - Table of PREVIOUS selected rows data (ROW type only) SELECTROW - Selection information for a row (see SELECT message) Switches: /EXIT= - on RETURN,MENU,MESSAGE or ALL [DEF=NONE in pipe mode, else ALL] NOTE: MESSAGE must be selected for MENU or RETURN to work. /DRAGDROP - Enable or disable drag and drop [DEF=Disabled] /DRAWHIDDEN- Populate the data from a list in a hidden pane (such as a tab) /GRID - ON,OFF. Turn grid on/off. Overrides template settings. /MSGID= - the ID to process messages from the remote nodes (usually 1) /OUTTYPE= - AUTO(def),VECTOR,TABLE if AUTO, depends on file type. If type 1000/2000 will output as VECTOR. Types 3000/4000/5000 output as TABLE. /POLL= - reread the current file every x seconds (does not compare the data to the old data) WARNING: Currently this reopens and reads the entire file. TBD to read only viewable data. /REFRESH= - Sets refresh mode ("Legacy" or "Timer"). [DEF="TIMER"] /RT - (doesn't do anything yet) /SCROLLEND - Scroll to end of list /COLLABELS - ON,OFF. Turn column labels on/off. Overrides template settings. /ROWLABELS - ON,OFF. Turn row labels on/off. Overrides template settings.