# coyote: CGDOTPLOT

- coyote/Graphics
- [Source code]

Description

      The purpose of cgDotPlot is to create a "dot plot" of the sort described on this
      `web page <http://peltiertech.com/Utility/DotPlotUtility.html>`.
       .. image:: cgdotplot.png

Categories

      Graphics

Params

      labels: in, required, type=strarr
           A vector of string labels to be plotted along the left edge of the dot plot.
      values: in, required
           A vector of values associated with each label, representing the values to be
           plotted on the dot plot.

Keywords

      addcmd: in, optional, type=boolean, default=0
         Set this keyword to add the command to the resizeable graphics window cgWindow.
      axiscolor: in, optional, type=string/integer, default='opposite'
         If this keyword is a string, the name of the axis color.
         Otherwise, the keyword is assumed to be a color index into the current color table.
      background: in, optional, type=string/integer, default='WHITE'
         If this keyword is a string, the name of the background color.
         Otherwise, the keyword is assumed to be a color index into the current color table.
      charsize: in, optional, type=float
         The character size for axes annotations. Uses cgDefCharSize to select default
         character size, unless !P.Charsize is set, in which case !P.Charsize is always used.
      color: in, optional, type=string/integer, default='BLACK'
         If this keyword is a string, the name of the data color.
         Color names are those used with cgColor. Otherwise, the keyword is assumed
         to be a color index into the current color table.
      font: in, optional, type=integer, default=!P.Font
         The type of font desired for axis annotation.
      labelcharsize: in, optional, type=float
         The character size of the labels. The default is to use `Charsize`.
      labelcolor: in, optional, type=string
         The name of the color the labels should be drawn in. The default is the
         `AxisColor`.
      nogrid: in, optional, type=boolean, default=0
         Set this keyword to eliminate the background grid from the plot.
      noerase: in, optional, type=boolean, default=0
         Set this keyword to draw the plot without erasing the display first.
      output: in, optional, type=string, default=""
         Set this keyword to the name of an output file. The type of file is determined
         from the file's extension, as listed below. Normally, the file name is given in
         all lowercase letters::
             'ps'   - PostScript file
             'eps'  - Encapsulated PostScript file
             'pdf'  - PDF file
             'bmp'  - BMP raster file
             'gif'  - GIF raster file
             'jpg' - JPEG raster file
             'png'  - PNG raster file
             'tif' - TIFF raster file
         All raster file output is created through PostScript intermediate files (the
         PostScript files will be deleted), so ImageMagick and Ghostview MUST be installed
         to produce anything other than PostScript output. (See cgPS2PDF and cgPS_Close for
         details.) And also note that you should NOT use this keyword when doing multiple
         plots. The keyword is to be used as a convenient way to get PostScript or raster
         output for a single graphics command. Output parameters can be set with `cgWindow_SetDefs`.
      overplot: in, optional, type=boolean, default=0
         Set this keyword if you wish to overplot data on an already exisiting set of
         cgDotPlot axes. Note that labels will have to be passed, but they will not be
         drawn again in the overplotting.
      position: in, optional, type=vector
         The usual four-element position vector for the Plot comamnd. Only monitored and
         possibly set if the `Aspect` keyword is used.
      psym: in, optional, type=integer
         Any normal IDL PSYM values, plus any value supported by the Coyote Library
         routine cgSYMCAT. An integer between 0 and 46. This may also be set to the
         "name" of a symbol, such as returned from Print, cgSymCat(/Names).
      plotfillcolor: in, optional, type=string, default='BLK1'
         The name of the color that fills the area inside the axes on the plot.
      symsize: in, optional, type=float, default=1.0
         The symbol size.
      title: in, optional, type=string
          The title of the plot.
      window: in, optional, type=boolean, default=0
         Set this keyword to replace all the commands in a current cgWindow or to
         create a new cgWindow for displaying this command.
      xcharsize: in, optional, type=float
         The character size of the annotations on the X axis of the plot.
      xgridstyle: in, optional, type=integer, default=1
         The X line style of the grid lines used to draw the grid on the axis. By default, dots.
      xrange: in, optional
         A two-element array giving the X range of the plot.
      xstyle: in, optional
         A two-element array giving the X style of the plot. Normally, this is
         set to 1 to give exact axis ranges. Otherwise, not used.
      xtitle: in, optional, type=string
          The X title of the plot.
      ygridstyle: in, optional, type=integer, default=1
         The Y line style of the grid lines used to draw the grid on the axis. By default, dots.

Examples

      There are several examples in a main-level program at the end of this program file.

Author

      FANNING SOFTWARE CONSULTING::
          David W. Fanning
          1645 Sheely Drive
          Fort Collins, CO 80526 USA
          Phone: 970-221-0438
          E-mail: david@idlcoyote.com
          Coyote's Guide to IDL Programming: http://www.idlcoyote.com

History

      Change History::
         Written, 12 November 2012, by David W. Fanning and donated to the IDL community
             by Marta Yebra of CSIRO, Australia.

Copyright

      Copyright (c) 2012, Fanning Software Consulting, Inc.