vline.pro

NRAO GBTIDL
Produced by IDL 7.1.1
User Documentation

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

SUMMARY: fields | routine DETAILS: routine

./plotter
vline.pro

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

vline

procedure vline, x, [label=string], [ylabel=float], [/noshow], [/ynorm], [idstring=string]

Mark a verticle line at the given x-location. Optionally include a label at the same x and the given y-location.

Version: $Id$
Common blocks: gbtplot_common

Parameters

x
in, required
float The x-location to draw the vertical line. In the current x-axis units.

Keywords

label
in, optional
string The label to associate with this vertical line.

ylabel
in, optional
float The y-location to put the optional label text. ylabel is required if label is specified.

noshow
in, optional
boolean Don't immediately show the new vline. This is useful if you are stringing several vline calls together. It keeps the plotter from updating after each call and make the whole operation run faster. Simply call "reshow" when you are ready to show the final result.

ynorm
in, optional
boolean The y-position for the label is in normalized coordinates when this keyword is set. That means that the label maintains its position relative to the entire y-axis no matter what changes in y-range (zoom) and x-axis.

idstring
in, optional
string An string to use to identify this particular vline. This can be used in clearvlines to clear a particular vline or group of vlines having the same idstring. The default is an empty string.

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

Parameters
x in, required float	The x-location to draw the vertical line. In the current x-axis units.

Keywords
label in, optional string	The label to associate with this vertical line.
ylabel in, optional float	The y-location to put the optional label text. ylabel is required if label is specified.
noshow in, optional boolean	Don't immediately show the new vline. This is useful if you are stringing several vline calls together. It keeps the plotter from updating after each call and make the whole operation run faster. Simply call "reshow" when you are ready to show the final result.
ynorm in, optional boolean	The y-position for the label is in normalized coordinates when this keyword is set. That means that the label maintains its position relative to the entire y-axis no matter what changes in y-range (zoom) and x-axis.
idstring in, optional string	An string to use to identify this particular vline. This can be used in clearvlines to clear a particular vline or group of vlines having the same idstring. The default is an empty string.