show_header.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./plotter
show_header.pro

Last modification date:: Wed Sep 28 13:27:13 2016

show_header

procedure show_header, [dc=data container], [charsize=float], [label_dc=string], [foreground=color], [/nocolor], [/noshow], [height=variable]

This procedure draws header information on the plot. It is intended to be used only by the other gbtidl plotter procedures. It is not an end-user procedure.

Version: $Id$
Common blocks: gbtplot_common

Keywords

dc
in, optional
data container data container

charsize
in, optional
float character size; needed for ps generation

label_dc
in, optional
string label for DC, shown at bottom of plot by time stamp

foreground
in, optional
color (def. !g.foreground) The foreground color.

nocolor
in, optional
boolean (def. F) When set, all fields are printed with the foreground color. When not set (the default), some fields are highlighted with color (!green and !red).

noshow
in, optional
boolean When set, then nothing is printed on the plot surface. This is to be used with height so that show_support can know how much space to reserve for the header.

height
out, optional
variable The number of lines, in units of charsize where 1 line is large enough to hold one row of charsize characters, that this header will take. Since the header might be small, this number can vary. This should be used with /noshow so that show_support can reserve an appropriate amount of space for the header and expand the plot surface when possible.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:21 2016

Keywords
dc in, optional data container	data container
charsize in, optional float	character size; needed for ps generation
label_dc in, optional string	label for DC, shown at bottom of plot by time stamp
foreground in, optional color (def. !g.foreground)	The foreground color.
nocolor in, optional boolean (def. F)	When set, all fields are printed with the foreground color. When not set (the default), some fields are highlighted with color (!green and !red).
noshow in, optional boolean	When set, then nothing is printed on the plot surface. This is to be used with height so that show_support can know how much space to reserve for the header.
height out, optional variable	The number of lines, in units of charsize where 1 line is large enough to hold one row of charsize characters, that this header will take. Since the header might be small, this number can vary. This should be used with /noshow so that show_support can reserve an appropriate amount of space for the header and expand the plot surface when possible.