The features described in this topic are obsolete
and should not be used in new IDL code.

LIVE_LINE

Syntax | Arguments | Keywords | Examples | Version History | See Also

The LIVE_LINE procedure is an interface for line annotation.

Syntax

LIVE_LINE [, ARROW_ANGLE=value{1.0 to 179.0}] [, /ARROW_END] [, ARROW_SIZE=value{0.0 to 0.3}] [, /ARROW_START] [, COLOR='color name' ] [, /DIALOG] [, DIMENSIONS=[width, height]] [, ERROR=variable] [, /HIDE] [, LINESTYLE={0 | 1 | 2 | 3 | 4 | 5}] [, LOCATION=[x, y]] [, NAME=string] [, /NO_DRAW] [, /NO_SELECTION] [, REFERENCE_OUT=variable] [, THICK=pixels{1 to 10}] [, VISUALIZATION_IN=string] [, WINDOW_IN=string]

Arguments

None

Keywords

ARROW_ANGLE

Set this keyword to a floating-point number between 1.0 and 179.0 degrees to indicate the angle of the arrowheads. The default is 30.0.

ARROW_END

Set this keyword to indicate an arrowhead should be drawn at the end of the line. It is not drawn by default.

ARROW_SIZE

Set this keyword to a floating-point number between 0.0 and 0.3 (normalized coordinates) to indicate the size of the arrowheads. The default is 0.02.

ARROW_START

Set this keyword to indicate an arrowhead should be drawn at the start of the line. It is not drawn by default.

COLOR

Set this keyword to a string (case-sensitive) of the color to be used for the line. The default is `Black'. The following colors are available:

  • Black
  • Red
  • Green
  • Yellow
  • Blue
  • Magenta
  • Cyan
  • Dark Gray
  • Light Gray
  • Brown
  • Light Red
  • Light Green
  • Light Blue
  • Light Cyan
  • Light Magenta
  • White

DIALOG

Set this keyword to display the line properties dialog appear. The dialog will have all known properties supplied by keywords filled in.

DIMENSIONS

Set this keyword to a two-element vector of the form [width, height] to specify the X and Y components of the line in normalized coordinates. The default is [0.2, 0.2].

ERROR

Set this keyword to a named variable to contain the returned error message (string). An empty string is returned if no errors occurred during the operation. By default, errors are reported via a GUI.

Note
If a named variable is passed in this keyword and an error occurs, the error GUI will not be displayed.

HIDE

Set this keyword to a boolean value indicating whether this item should be hidden.

LINESTYLE

Set this keyword to a pre-defined line style integer:

LOCATION

Set this keyword to a two-element, floating-point vector of the form [X, Y] specifying the location of the visualization (relative to the lower left hand corner within the visualization window) in normalized coordinates. The default is [0.5, 0.5].

Note
LOCATION may be adjusted to take into account window decorations.

NAME

Set this keyword equal to a string containing the name to be associated with this item. The name must be unique within the given window or buffer (WINDOW_IN). If not specified, a unique name will be assigned automatically.

NO_DRAW

Set this keyword to inhibit the visualization window from drawing. This is useful if multiple visualizations and/or annotations are being created via calls to other LIVE_Tools in order to reduce unwanted draws and help speed the display.

REFERENCE_OUT

Set this keyword to a variable to return a structure defining names of the modified visualization's properties. The fields of the structure are shown in the following table.

Table 2-18: Fields of the LIVE_LINE Reference Structure

Tag
Description

WIN

Window Name

VIS

Visualization Name

GRAPHIC

Graphic Name the line created

THICK

Set this keyword to an integer value between 1 and 10, specifying the line thickness to be used to draw the line, in pixels. The default is one pixel.

VISUALIZATION_IN

Set this keyword equal to the name (string, case-insensitive) of a LIVE tool visualization. The VIS field from the REFERENCE_OUT keyword from the creation of the LIVE tool will provide the visualization name. If only one visualization is present in the window or buffer (WINDOW_IN), this keyword will default to it.

WINDOW_IN

Set this keyword equal to a name (string, case-sensitive) of a LIVE tool window or a LIVE tool buffer. The WIN tag of the REFERENCE_OUT structure from the creation of the LIVE tool will provide the window or buffer name. Window names are also visible in visualization window titlebars. If only one LIVE tool window (or buffer) is present in the IDL session, this keyword will default to it.

Examples 

LIVE_LINE, WINDOW_IN='Live Plot 2', $ 
   VISUALIZATION_IN='line plot visualization' 
; Units are in the visualization units ( based on axis ranges).

Version History

Introduced: 5.1

See Also

LIVE_RECT, LIVE_TEXT