home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / database / jk_graph.zip / GRAPH.DOC < prev    next >
Text File  |  1988-09-08  |  10KB  |  196 lines
  1.  
  2.                                    GRAPH
  3.                                 Version 0.5
  4.  
  5. Copyright (C) 1988, LINEAR Software Design, Jim Killeen. All Rights Reserved.
  6. -----------------------------------------------------------------------------
  7.  
  8.        ****  NOTE: This program requires an EGA graphics adapter. ****
  9.  
  10.  ***************************************************************************
  11.  |  To get right to the heart of the matter and see if you're interested   |
  12.  |  in continuing further, at the DOS prompt type:   DISPLAY               |
  13.  |  To EXIT each graph after it is displayed press any key.                |
  14.  |                                                                         |
  15.  |  DISPLAY is a batch file that shows the different graph formats using   |
  16.  |  different dBASE files.                                                 |         *
  17.  ***************************************************************************
  18.  
  19.       First, the bad news: this program currently will run ONLY on PC's
  20.   with an EGA. In addition, to print a graph, you must have an Epson or
  21.   Epson-compatible printer. While these limitations are expected to be
  22.   addressed in future releases (note the version number above), I am
  23.   currently providing this release to test the waters so to speak, and
  24.   to get input on features that people would like. This IS a beta version
  25.   and I am NOT asking for any money. Right now I am hoping to repay many
  26.   of the folks on the BOSS BBS for all the help I have received there
  27.   (though this is small payment). I DO ask however, that this not be
  28.   uploaded to other BBS's, at least not at this time. The reason for this
  29.   is that I currently do not have the time needed to provide effective
  30.   support (beyond questions asked on the BOSS in the Clipper area), and
  31.   given the limited documentation, it WILL require support. With those
  32.   Caveats in mind, there ARE some good points.
  33.  
  34.      The good news: GRAPH allows an individual to graphically display
  35.   numeric data stored in a dbase file, in BAR and LINE graph formats. The
  36.   data is automatically scaled to provide appropriate representation. You
  37.   have the options of horizontal or vertical grids, or both. Colors can be
  38.   selected for the border, the BARS or LINES, the titles, the numbers and
  39.   descriptions, and the grids. Three "titles" are allowed, two at the top
  40.   one at the bottom, and they are automatically centered. Descriptions of
  41.   the elements are centered below each item (any excess is truncated).
  42.  
  43.   When GRAPH is executed it expects the name of two files on the command
  44.   line. (I currently run GRAPH from most of my Clipper applications by
  45.   using the "RUN" or "!" comand). The first is a dbase file containing the
  46.   settings: the type of graph (BAR, LINE), colors , status of the grid
  47.   (off, horizontal, vertical, both) etc. The second file contains the actual
  48.   data to create the graph from. This second file consists of two fields:
  49.   one for the numeric data, and one for the description. While the names of
  50.   the FIELDS in the dBASE file structures CAN be modified, their length can
  51.   NOT. Currently, the BAR graph allows up to 12 records (you can append more,
  52.   but only twelve will be displayed), and the line graph allows up to 31
  53.   records. While this arrangement is limiting, it should provide ample use
  54.   for most purposes, and it too is expected to be revised. Right now I
  55.   prefer to use only two settings files, one I have set up for BAR graphs,
  56.   the other for LINE graphs. Prior to using either I REPLACE the approp-
  57.   riate title strings with what I need and then send along the proper data
  58.   file.
  59.  
  60.  
  61.  
  62.   The File Structures and what they mean:
  63.   --------------------------------------------------------------------------
  64.  
  65.   The Settings File:
  66.  
  67.       The first parameter passed to GRAPH from the command line is the
  68.   name of the settings file. Below is the dBASE structure for this file:
  69.  
  70.   **********************************************
  71.   Field  Field Name  Type       Width    Dec
  72.       1  TOP_TITLE1  Character     60
  73.       2  TOP_TITLE2  Character     60
  74.       3  BOTT_TITLE  Character     60
  75.       4  TITLE_CLR   Numeric        1
  76.       5  SCALE_CLR   Numeric        1
  77.       6  BORDER_CLR  Numeric        1
  78.       7  BAR_CLR     Numeric        1
  79.       8  SHADOW_CLR  Numeric        1
  80.       9  GRID        Numeric        1
  81.      10  GRAPH_TYPE  Numeric        1
  82.   ** Total **                     188
  83.   ***********************************************
  84.  
  85.     Remember, the Field Name can be changed to anything you might prefer,
  86.   but the Width must NOT be altered. Here are the descriptions of each
  87.   field:
  88.  
  89.   Field 1: This represents the first title at the very top of the screen.
  90.            60 Characters should be more than enough for anyone who is not
  91.            extremely long-winded. The field is centered on screen.
  92.   Field 2: This is positioned on the line directly below Field 1.
  93.   Field 3: Positioned at the very bottom of the screen, and centered.
  94.   Field 4: Represents the color of all the titles (Fields 1,2 and 3).
  95.            (See valid color codes below).
  96.   Field 5: Represents the color of the numbers along the 'Y' Scale, as well
  97.            as the descriptions of each element along the bottom border.
  98.            (See valid color codes below).
  99.   Field 6: Represents the color of the border of the graph.
  100.            (See valid color codes below).
  101.   Field 7: Represents the color of the BARS or the LINES, depending on
  102.            which graph type has been indicated.
  103.            (See valid color codes below).
  104.   Field 8: Represents the "depth" of the BARS, that provides the extra
  105.            dimension.
  106.            (See valid color codes below).
  107.   Field 9: This indicates the following:
  108.            A Value of 0: No grid is to be used
  109.                 "     1: Horizontal Grid only
  110.                 "     2: Vertical Grid only
  111.                 "     3: Both Horizontal and Vertical Grids
  112.  Field 10: Indicates the type of graph desired:
  113.            A Value of 0: Line Graph
  114.                 "     1: Bar Graph
  115.                 "     2: NOTE: I probably shouldn't have mentioned this one
  116.     but someone is gonna' come across it. I am currently working on providing
  117.     pie charts. This is the INCOMPLETE and NON-WORKING code for pie-charts.
  118.     If you must use this code bear in mind that when the pie is displayed
  119.     you must step through the presentation of each element by pressing
  120.     the return key. (Remember the words "Beta Version").
  121.  
  122.  
  123.  
  124.   Valid Color Codes:
  125.  
  126.          1: Blue
  127.          2: Green
  128.          3: Cyan
  129.          4: Red
  130.          5: Purple
  131.          6: Brown
  132.          7: White
  133.  
  134.  
  135.  
  136.   The Data File:
  137.  
  138.       The second parameter passed to GRAPH from the command line is the
  139.   name of the data file. Below is the dBASE structure for this file:
  140.  
  141.   **********************************************
  142.   Field  Field Name  Type       Width    Dec
  143.       1  DESCRIPT    Character     20
  144.       2  AMT_1       Numeric       10
  145.   ** Total **                      31
  146.   **********************************************
  147.  
  148.     Again, the Field Name can be changed to anything you might prefer,
  149.   but the Width must NOT be altered. Here are the descriptions of each
  150.   field:
  151.  
  152.   Field 1: Description, can contain up to 20 characters. Not all of these
  153.            characters will necessarily be displayed. GRAPH truncates any
  154.            characters that will not fit in the space needed below each item.
  155.            If you are only displaying three or four records, odds are that
  156.            you will see all the characters. It is when more elements are
  157.            being displayed that this area becomes more crowded, and the
  158.            descriptions must be adjusted to accomodate the space allotted.
  159.            These decriptions are centered below each BAR or LINE.
  160.  
  161.   Field 2: This field contains the numeric value to be scaled. GRAPH looks
  162.            at the numeric elements of all the records and decides how to
  163.            scale them accordingly. It determines if the values should be
  164.            represented directly, or in thousands or millions, and places a
  165.            note to that effect at the top of the 'Y' Scale. When using
  166.            BAR graphs, if one element is disproportionate to the others,
  167.            GRAPH displays the other majority of elements in relation to
  168.            each other, and shows the larger item at the full height of the
  169.            graph. In addition, the exact amount of that item is displayed
  170.            next to it's BAR. For example, given the 5 elements 120, 150,
  171.            145, 9800, 170: The top scale would be 200, with the 9800 item
  172.            shown as the full height of the graph.
  173.  
  174.  
  175.  
  176.   Printing Graphs:
  177.   ----------------
  178.  
  179.     Graphs can currently be printed on an Epson or Epson-compatible printer.
  180.   This is accomplished by pressing the letter 'P' while looking at the
  181.   graph on your screen. The most severe limitation here is that the graph
  182.   can be printed in one size and with one orientation. Support for additional
  183.   printers and optional graph sizes are both on the "things to do" list.
  184.  
  185.  
  186.  
  187.   I hope the above information has been helpful enough but once again,
  188.   I have limited time available (doesn't everybody), but wanted to provide
  189.   something in the meantime until I can REALLY make this baby sing.
  190.   It is very important to me to hear your thoughts on this program, if you
  191.   would please send me mail on the BOSS.BBS in the Clipper area, I will try
  192.   to answer what questions I can. Enjoy!
  193.  
  194.   BOSS.BBS
  195.   (201) 568-7293
  196.   Jim Killeen