addcmd: in, optional, type=boolean, default=0
Set this keyword to add the command to an cgWindow. Setting this keyword
automatically sets the WINDOW keyword, but the command does not erase the
graphics window as it would normally.
alignment: in, optional, type=integer, default=0
Set this keyword to indicate the alignment of the text with respect to the
x and y location. 0 is left aligned, 0.5 is centered, and 1.0 is right aligned.
The alignment is set to 0.5 if PLACE is set and ALIGNMENT is unspecified.
Otherwise, the default is 0.
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, default="opposite"
The color of the text. Color names are those used with cgColor.
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.
map_object: in, optional, type=object
If you are drawing on a map projection set up with Map_Proj_Init
and using projected meter space, rather than lat/lon space, then you can use this
keyword to provide a cgMap object that will allow you to convert the `x` and `y`
parameters from longitude and latitude, respectively, to projected meter space
before drawing.
normal: in, optional, type=boolean
Set this keyword to indicate xloc and yloc are in normalized coordinates.
orientation: in, optional, type=float, default=0.0
Use this keyword to specify the counterclockwise angle of rotation of the text
in degrees from the horizontal.
outloc: out, optional, type=various
Only used if PLACE is set, this is a two-element array containing the xloc and yloc
of the cursor position in the window.
place: in, optional, type=boolean
Set this keyword if you wish to click the cursor in the graphics window to place
the text. If this keyword is set, you do not need to specify the `xloc` and `yloc`
positional parameters. The first positional parameter is assumed to be the text.
The clicked location will be returned in the `OutLoc` variable. If the `Alignment`
keyword is not set, it will be set to 0.5 to set "center" as the default placement
alignment. This has been modified to allow this keyword to work in a resizeable
graphics window as well. Clicking once in the window will set the parameters so
you don't have to click every time the window is resized.
tt_font: in, optional, type=string
The true-type font to use for the text. Only used if FONT=1.
width: out, optional, type=float
Set this keyword to a named variable in which to return the width of the text string,
in normalized coordinate units. Note that output keyword values cannot be returned
from the routine if the command is being executed in a cgWindow.
window: in, optional, type=boolean
Set this keyword to add the command to the in the current cgWindow application.
_ref_extra: in, optional
Any `IDL XYOutS keyword `
not defined here is allowed in the program.