[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


cxyouts Source code in cxyouts.pro

cxyouts

Name
             cxyouts
Purpose
             The CXYOUTS procedure draws text on the currently
             selected graphics device starting at the designated
             coordinate while supporting strings with color
             information. The string escapes the color information
             with "!f<color>", e.g. "foo!f100bar" draws "bar" with
             color 100.
Category
             Plot utilities
Calling Sequence
       XYOUTS, [X, Y,] String [, ALIGNMENT=value{0.0 to 1.0}] [, CHARSIZE=value]
      [, CHARTHICK=value] [, TEXT_AXES={0 | 1 | 2 | 3 | 4 | 5}] [,
      WIDTH=variable] [, CLIP=[X0, Y0, X1, Y1] | , /NOCLIP] [,
      COLOR=index] [, /DATA | , /DEVICE | , /NORMAL] [, ORIENTATION=
      ccw_degrees_from_horiz] [, /T3D | Z=value]
Input Parameters
       X, Y: The horizontal and vertical coordinates
             used to position the string(s). X and Y are
             normally interpreted in data coordinates.
             The DEVICE and NORMAL keywords can
             be used to specify the coordinate units.
             X and Y should be a scalar (this differs from xyouts).
     String: The string(s) to be output. Should be scalar string.
Optional Input Parameters
  ALIGNMENT: Specifies the alignment of the text
             baseline.      An alignment of 0.0 (the default) aligns
             the left edge of the text baseline with the given
             (x, y) coordinate. An alignment of 1.0
             right-justifies the text, while 0.5 results in text
             centered over the point (x, y).
   CHARSIZE: The overall character size for the
             annotation.      A CHARSIZE of 1.0 is normal. Setting
             CHARSIZE = -1 suppresses output of the text
             string. This keyword has no effect when used with
             the hardware drawn fonts      for exceptions, see
             "Scaled Hardware Fonts" on page 1602.
  CHARTHICK: The line thickness of the vector drawn
             font characters. This keyword has no effect      when
             used with the hardware drawn fonts     for exceptions,
             see "Scaled Hardware Fonts" on page 1602. The
             default value is 1.0.
  TEXT_AXES: This keyword specifies the plane of
             vector drawn text when three-dimensional plotting
             is enabled. By default, text is      drawn in the plane
             of the XY axes. The      horizontal text direction is in
             the X plane,      and the vertical text direction is in
             the Y plane. Values for this keyword can range from
             0 to 5, with the following effects: 0 for XY, 1 for
             XZ, 2 for YZ, 3 for YX, 4 for ZX, and 5 for ZY. The
             notation ZY means that the horizontal direction of
             the text lies in the Z plane, and the vertical
             direction of the text is drawn in the Y plane.
      WIDTH: Set this keyword to a named variable in which
             to return the width of the text string, in
             normalized coordinate units.
GRAPHICS KEYWORDS:
       See Appendix C, "Graphics Keywords" for
       the description of graphics and plotting
       keywords not listed above.
       CLIP, COLOR, DATA, DEVICE, FONT, NOCLIP, NORMAL, ORIENTATION,
       T3D, Z.
Output Parameters
              Plots text on current device.
Optional Output

Side Effects

Restrictions

Procedure
             Splits input string according !f<num>-expressions and
             plots out each part with the referenced color.
Example
            cxyouts,0.5,0.5,"Hello!f250 World",/normal,charsize=2
            -> world will be painted with color 250 (red for color
               table 39)
Revision History
            $Log: cxyouts.pro,v $
            Revision 1.2  2004/12/01 16:12:49  goehler
            fix to allow font=0 text
            Revision 1.1  2004/11/29 09:46:55  goehler
            initial version of color output tool

Last modified by pro2html on 2005 January 04 at 16:38 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically