LIVE_RECT

Keywords

COLOR

Set this keyword to a string (case-sensitive) of the color to be used for the rectangle. The color must be specified as an Insight color. The default is `Black'. Available colors are listed in the table below.

`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 have an Insight rectangle dialog appear. This dialog will fill in known attributes from set keywords.

DIMENSIONS

Set this keyword to a two-element, floating-point vector of the form [width, height] to specify the dimensions of the rectangle 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.

0 = Visible (default)
1 = Hidden

LINESTYLE

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

0 = Solid line (default)
1 = dotted
2 = dashed
3 = dash dot
4 = dash dot dot dot
5 = long dash

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.0, 0.0].

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 the names of the modified items. The fields of the structure are shown in the following table.

Fields of the LIVE_RECT Reference Structure
Tag	Description
WIN	Window Name
VIS	Visualization Name
GRAPHIC	Graphic Name the rectangle 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 or Insight visualization. The VISUALIZATION field from the REFERENCE_OUT keyword from the creation of the LIVE tool will provide the visualization name. Visualization names are also visible in Insight's Visualization Manager and visualization property dialogs. 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 or Insight window, or a LIVE tool buffer. The WINDOW 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 or Insight window (or buffer) is present in the IDL session, this keyword will default to it.