Utilities/
text_box.pro
This procedure writes a short text message within a box-shaped
area in a graphic window. The message may be split at word
boundaries into several lines, and the character size and
orientation may be adjusted for the text to fit within the box.
text_box
text_box, text, POS=POS, FG_COLOR=FG_COLOR, BG_COLOR=BG_COLOR, CENTER=CENTER, RIGHT=RIGHT, BOX=BOX, VERT_SPACE=VERT_SPACE, _EXTRA=_EXTRA
Parameters
text
in
required
type: string
message in ASCII.
Keywords
POS
4 elements vector specifying the box position and size
pos[0],pos[1] specify the lower left corner coordinate,
pos[2],pos[3] specify the upper right corner coordinate,
data window normalized coordinates are used.
FG_COLOR
default: 0
color of box and legend titles
BG_COLOR
background color.
Setting BG_COLOR erases the area
covered by the text box (filling it with color BG_COLOR)
prior to writing the text. If both BG_COLOR and !p.color
are zero then the background color is reset to 255 to
guarantee a readability.
CENTER
if set, center the text
RIGHT
if set, right justify text
BOX
activate to show the box on graphic window.
VERT_SPACE
default: 1.5
vertical spacing of lines in units of character height
_EXTRA
Used to pass keywords
Version history
Version
$Id: text_box.pro 375 2008-08-08 15:55:40Z pinsard $
History
Paul Ricchiazzi 7Jul93
Institute for Computational Earth System Science
University of California, Santa Barbara
Produced by IDLdoc 2.0.