Keywords
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.
PROPERTIES
Set this keyword to a named variable to contain the returned properties structure.
|
Tag
|
Description
|
|
dimensions
|
2-element integer vector (pixels)
|
|
hide
|
boolean (0-show, 1=hide)
|
|
location
|
2-element integer vector (pixels) from upper left corner of screen
|
|
title
|
string
|
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.
Structure Tables for LIVE_INFO and LIVE CONTROL
The following tables describe various structures used by LIVE_INFO and LIVE_CONTROL for: line annotation, rectangle annotation, text annotation, axis, colorbar, contour, image, legend, surface, and visualization.
Color Names
The following color names are the possible values of the color property fo r annotations included in a LIVE_ window: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'
|
Line Annotations
If you retrieve properties on a line annoation, the PROPERTIES keyword will return a structure with the following fields:
-
Line Annotation Properties Structure
|
Tag
|
Description
|
|
thick
|
1 to 10 pixels
|
|
arrow_start
|
1 = arrow head at line start, 0 = no arrowhead
|
|
arrow_end
|
1 = arrow head at line start, 0 = no arrowhead
|
|
arrow_size
|
0.0 to 0.3 normal units
|
|
arrow_angle
|
1.0 to 179.0 degrees
|
|
linestyle
|
0 to 5 (solid, dotted, dashed, dash dot, dash dot dot dot, long dash)
|
|
hide
|
1 = hidden, 0 = visible
|
|
name
|
scalar string (unique within all graphics)
|
|
color
|
see
Color Names
·
|
|
location
|
[x, y] normal units
|
|
dimensions
|
[width, height] normal units
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Rectangle Annotations
If you retrieve properties on a rectangle annoation, the PROPERTIES keyword will return a structure with the following fields:
-
Rectangle Annotation Properties Structure
|
Tag
|
Description
|
|
thick
|
1 to 10 pixels
|
|
linestyle
|
0 to 5 (solid, dotted, dashed, dash dot, dash dot dot dot, long dash)
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
color
|
see
Color Names
·
|
|
location
|
[x, y] normal units
|
|
dimensions
|
[width, height] normal units
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Text Annotations
If you retrieve properties on a text annoation, the PROPERTIES keyword will return a structure with the following fields:
-
Text Annotation Properties Structure.
|
Tag
|
Description
|
|
fontsize
|
9 to 72 points
|
|
fontname
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
textangle
|
0.0 to 360.0 degrees
|
|
alignment
|
0.0 to 1.0 where 0.0 = right justified and 1.0 = left justified
|
|
location
|
[x, y] normal units
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
ann_formula
|
Ascalar string or vector of strings.
It can contain one or more data item names, enclosed in vertical bars (|) which will be substituted with the respective data value.
|
|
enable_formatting
|
set to allow "!" chars for font commands
|
|
strings
|
scalar or vector of strings as the text annotation value
|
|
color
|
see
Color Names
·
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Axes
If you retrieve properties on an axis, the PROPERTIES keyword will return a structure with the following fields:
-
Axis Properties Structure
|
Tag
|
Description
|
|
title_FontSize
|
9 to 72 points
|
|
title_Fontname
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
title_Color
|
see
Color Names
·
|
|
tick_FontSize
|
9 to 72 points
|
|
tick_Fontname
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
tick_FontColor
|
see
Color Names
·
|
|
gridStyle
|
see linestyle
|
|
color
|
see
Color Names
·
|
|
thick
|
1 to 10 pixels
|
|
location
|
[x, y] data units
|
|
minor
|
number of minor ticks (minimum 0)
|
|
major
|
number of major ticks (minimum 0)
|
|
default_minor
|
set to compute default number of minor ticks
|
|
default_major
|
set to compute default number of major ticks
|
|
tickLen
|
normal units * 100 = percent of visualization dimensions
|
|
subticklen
|
normal units * 100 = percent of ticklen
|
|
tickDir
|
0 = up (or right), 1 = down (or left)
|
|
textPos
|
0 = below (or left), 1 = above (or right)
|
|
tickFormat
|
standard IDL FORMAT string (See STRING function) excluding parentheses
|
|
exact
|
set to use exact range specified
|
|
log
|
set to display axis as log
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
compute_range
|
set to compute axis range from data min/max
|
|
tickName
|
if defined, vector of strings to use at major tick marks
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Colorbars
If you retrieve properties on a colorbar, the PROPERTIES keyword will return a structure with the following fields:
-
Colorbar Properties Structure.
|
Tag
|
Description
|
|
title_Fontsize
|
9 to 72 points
|
|
title_Fontname
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
title_Color
|
see
Color Names
·
|
|
tick_FontSize
|
see fontsize
|
|
tick_Fontname
|
see fontname
|
|
tick_FontColor
|
see
Color Names
·
|
|
color
|
see
Color Names
·
|
|
thick
|
1 to 10 pixels
|
|
location
|
[x, y] normal units
|
|
minor
|
number of minor ticks (minimum 0)
|
|
major
|
number of major ticks (minimum 0)
|
|
default_minor
|
set to compute default number of minor ticks
|
|
default_major
|
set to compute default number of major ticks
|
|
tickLen
|
normal units * 100 = percent of visualization dimensions
|
|
subticklen
|
normal units * 100 = percent of ticklen
|
|
tickFormat
|
standard IDL FORMAT string (See STRING function) excluding parentheses
|
|
show_axis
|
set to display the colorbar axis
|
|
show_outline
|
set to display the colorbar outline
|
|
axis_thick
|
see thick
|
|
dimensions
|
[width, height] normal units
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Contours
If you retrieve properties on a contour, the PROPERTIES keyword will return a structure with the following fields:
-
Contour Properties Structure
|
Tag
|
Description
|
|
min_value
|
minimum contour value to display
|
|
max_value
|
maximum contour value to display
|
|
downhill
|
set to display downhill tick marks
|
|
fill
|
set to display contour levels as filled
|
|
c_thick
|
vector of thickness values (see thick)
|
|
c_linestyle
|
vector of linestyle values (see linestyle)
|
|
c_color
|
vector of color names (see
Color Names
)
|
|
default_n_levels
|
set to default the number of levels
|
|
n_levels
|
specify a positive number for a specific number of levels
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Images
If you retrieve properties on an image, the PROPERTIES keyword will return a structure with the following fields:
-
Image Properties Structure
|
Tag
|
Description
|
|
order
|
set to draw from top to bottom
|
|
sizing_constraint
|
[0|1|2] 0=Natural, 1=Aspect, 2=Unrestricted
|
|
dont_byte_scale
|
set to inhibit byte scaling the image
|
|
palette
|
name of managed colortable
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in LIVE_INFO structure if defined)
|
Legends
If you retrieve properties on a legend, the PROPERTIES keyword will return a structure with the following fields:
-
Legend Properties Structure
|
Tag
|
Description
|
|
title_FontSize
|
9 to 72 points
|
|
title_Fontname
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
title_Color
|
see
Color Names
·
|
|
item_fontSize
|
see fontsize
|
|
item_fontName
|
Helvetica, Courier, Times, Symbol, and Other (where Other is a valid name of a font on the local system)
|
|
text_color
|
color of item text (see
Color Names
)
|
|
border_gap
|
normal units * 100 = percent of item text height
|
|
columns
|
number of columns to display the items in (minimum 0)
|
|
gap
|
normal units * 100 = percent of item text height
|
|
glyph_Width
|
normal units * 100 = percent of item text height
|
|
fill_color
|
see
Color Names
·
|
|
outline_color
|
see
Color Names
·
|
|
outline_thick
|
see thick
|
|
location
|
[x, y] normal units
|
|
show_fill
|
set to display the fill color
|
|
show_outline
|
set to display the legend outline
|
|
title_text
|
String to display in the legend title
|
|
item_format
|
standard IDL FORMAT string (See STRING function) excluding parentheses (contour legends only)
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Surfaces
If you retrieve properties on a surface, the PROPERTIES keyword will return a structure with the following fields:
-
Surface Properties Structure
|
Tag
|
Description
|
|
min_value
|
minimum plot line value to display
|
|
max_value
|
maximum plot line value to display
|
|
lineStyle
|
0 to 5 (solid, dotted, dashed, dash dot, dash dot dot dot, long dash)
|
|
color
|
see
Color Names
·
|
|
thick
|
1 to 10 pixels
|
|
bottom
|
see
Color Names
·
|
|
style
|
0 to 5 0=point, 1=wire, 2=solid, 3=ruledXZ, 4=ruledYZ,5=lego (wire), 6=lego (solid)
|
|
shading
|
0=flat, 1=Gouraud
|
|
hidden_lines
|
set to not display hidden lines or points
|
|
show_skirt
|
set to display the surface skirt
|
|
skirt
|
z value at which skirt is drawn (data units)
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
Entire Visualizations
If you retrieve properties on an entire visualization, the PROPERTIES keyword will return a structure with the following fields:
-
Visualization Properties Structure
|
Tag
|
Description
|
|
location
|
[x, y] normal units
|
|
dimensions
|
[width, height] normal units
|
|
transparent
|
set to avoid erasing to the background color
|
|
color
|
background color (see
Color Names
)
|
|
hide
|
1=hidden, 0=visible
|
|
name
|
scalar string (unique within all graphics)
|
|
uvalue
|
any value of any type (only returned in structure if defined)
|
