# coyote: CGAXIS

- coyote/Graphics
- [Source code]

Description

      Provides a device-independent and color-model-independent way to draw an axis into
      a graphics window. It is a wrapper to the AXIS command.
      The program requires the `Coyote Library <http://www.idlcoyote.com/documents/programs.php>`
      to be installed on your machine.

Categories

      Graphics

Params

      xloc: in, optional, type=depends
         The X location of the axis.
      yloc: in, optional, type=depends
         The Y location of the axis.
      zloc: in, optional, type=depends
         The Z location of the axis.

Keywords

      charsize: in, optional, type=float, default=cgDefCharSize()
          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/long
          The color of the text. Color names are those used with cgColor. By default,
          "black", unless the upper-right hand pixel in the display is black, then "white".
      data: in, optional, type=boolean
          Set this keyword to indicate xloc and yloc are in data coordinates. Data coordinates
          are the default, unless DEVICE or NORMAL is set.
      device: in, optional, type=boolean
          Set this keyword to indicate xloc and yloc are in device coordinates.
      font: in, optional, type=integer, default=!P.Font
          The type of font desired. By default, !P.Font.
      normal: in, optional, type=boolean
          Set this keyword to indicate xloc and yloc are in normalized coordinates.
      save: in, optional, type=boolean
          Set this keyword to save the scaling parameters set by the axis for subsequent use.
      t3d: in, optional, type=boolean, default=0
          Set this keyword to rotate the axis is the 3D data space set up with !P.T.
      title: in, optional, type=string, default=""
          The title or annotation that appears on the axis.
      window: in, optional, type=boolean
          Set this keyword to add the command to the in the current cgWindow application.
      xaxis: in, optional, type=integer, default=0
          If set to 0, the axis is drawn under the plot with the tick marks pointing up; if set
          to 1, the axis is drawn on top of the plot with the tick marks pointing down.
      xlog: in, optional, type=boolean, default=0
          Set this keyword to specify a logarithmic axis type.
      xtitle: in, optional, type=string
          An alternative way to set the `Title` keyword for X axes. Use `Title` instead.
      yaxis: in, optional, type=integer, default=0
          If set to 0, the axis is drawn on the left of the plot with the tick marks pointing
          to the right. If set to 1, the axis is drawn on the right of the plot with the tick
          marks pointing to the left.
      ylog: in, optional, type=boolean, default=0
          Set this keyword to specify a logarithmic axis type.
      ynozero: in, optional, type=boolean, default=0
          Set this keyword to prevent the Y axis from starting at 0.
      ytitle: in, optional, type=string
          An alternative way to set the `Title` keyword for Y axes. Use `Title` instead.
      zaxis: in, optional, type=integer, default=0
          Set to 0-3 to position the Z axis in various locatons. See the AXIS documentation.
      zlog: in, optional, type=boolean, default=0
          Set this keyword to specify a logarithmic axis type.
      ztitle: in, optional, type=string
          An alternative way to set the `Title` keyword for Z axes. Use `Title` instead.
      _ref_extra: in, optional
           Any keywords appropriate for the AXIS command.

Examples

      Used like the IDL AXIS command::
         IDL> cgPlot, cgDemoData(1), YStyle=8, Position=[0.1, 0.1, 0.85, 0.9], /Window
         IDL> cgAxis, /YAxis, Color='red', YRange=[-500, 500], /Save, /Window

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, 25 Janauray 2011. DWF.
         Modified error handler to restore the entry decomposition state if there is an error. 17 March 2011. DWF
         Modifed the way I am handling brain dead AXIS command. 30 May 2011. DWF.
         Modified to use cgDefaultColor for default color selection. 24 Dec 2011. DWF.
         Added T3D keyword. 1 March 2012. DWF.
         Added the ability to use escape characters in plot titles to specify cgSymbol symbols. 27 July 2012. DWF.

Copyright

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