The features described in this topic are obsolete
and should not be used in new IDL code.
LIVE_INFO
The LIVE_INFO procedure allows the user to get the properties of a LIVE tool.
Syntax
LIVE_INFO, [Name] [, ERROR=variable] [, PROPERTIES=variable] [, WINDOW_IN=string]
Arguments
Name
A string containing the name of a visualization or element (case-insensitive). The default is to use the window or buffer (WINDOW_IN).
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. For a description of the structures, see Properties Structures below.
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.
Structure Tables for LIVE_INFO and LIVE CONTROL
The following tables describe the properties structures used by LIVE_INFO and LIVE_CONTROL (via the PROPERTIES keyword) for:
Color Names
The following color names are the possible values for color properties:
Line Annotations
The fields in the properties structure of Line Annotations are as follows:
|
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 normalized units |
| arrow_angle |
1.0 to 179.0 degrees |
| linestyle |
0=solid, 1=dotted, 2=dashed, 3=dash dot, 4=dash dot dot, 5=long dash |
| hide |
1 = hidden, 0 = visible |
| name |
scalar string (unique within all graphics) |
| color |
see Color Names |
| location |
[x, y] normalized units |
| dimensions |
[width, height] normalized units |
| uvalue |
any value of any type (only returned in structure if defined) |
Rectangle Annotations
The fields in the properties structure of Rectangle Annotations are as follows:
|
Tag
|
Description
|
|---|---|
| thick |
1 to 10 pixels |
| linestyle |
0=solid, 1=dotted, 2=dashed, 3=dash dot, 4=dash dot dot, 5=long dash |
| hide |
1=hidden, 0=visible |
| name |
scalar string (unique within all graphics) |
| color |
see Color Names |
| location |
[x, y] normalized units |
| dimensions |
[width, height] normalized units |
| uvalue |
any value of any type (only returned in structure if defined) |
Text Annotations
The fields in the properties structure of Text Annotations are as follows:
|
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] normalized units |
| hide |
1=hidden, 0=visible |
| name |
scalar string (unique within all graphics) |
| value |
string (scalar or vector) annotation formula (see note below) |
| enable_formatting |
set to allow "!" chars for font commands |
| color |
see Color Names |
| uvalue |
any value of any type (only returned in structure if defined) |
Note
Each vector element of the annotation formula (see "value" tag above) is parsed once, left to right, for vertical bars (|).
Axes
The fields in the properties structure of Axes are as follows:
|
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 |
normalized units * 100 = percent of visualization dimensions |
| subticklen |
normalized 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
The fields in the properties structure of Colorbars are as follows:
|
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]; where [0, 0] = lower left and [1, 1] = position where the entire colorbar fits into the upper right of the visualization |
| 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 |
normalized units * 100 = percent of visualization dimensions |
| subticklen |
normalized 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] normalized 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
The fields in the properties structure of Contours are as follows:
|
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) |
| *The MIN and MAX value of the data are returned as contour levels when N_LEVELS is set. Because of this, when setting N_LEVELS, contour plots appear to have N-2 contour levels because the first (MIN) and last (MAX) level is not shown. With LIVE_CONTOUR, this results in a legend that contains unnecessary items in the legend (the MIN and the MAX contour level). |
|
Images
The fields in the properties structure of Images are as follows:
Legends
The fields in the properties structure of Legends are as follows:
|
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 |
normalized units * 100 = percent of item text height |
| columns |
number of columns to display the items in (minimum 0) |
| gap |
normalized units * 100 = percent of item text height |
| glyph_Width |
normalized units * 100 = percent of item text height |
| fill_color |
see Color Names |
| outline_color |
see Color Names |
| outline_thick |
see thick |
| location |
[x, y]; where [0, 0] = lower left and [1, 1] = position where the entire legend fits into the upper right of the visualization |
| 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
The fields in the properties structure of Surfaces are as follows:
|
Tag
|
Description
|
|---|---|
| min_value |
minimum plot line value to display |
| max_value |
maximum plot line value to display |
| lineStyle |
0=solid, 1=dotted, 2=dashed, 3=dash dot, 4=dash dot dot, 5=long dash |
| color |
see Color Names |
| thick |
1 to 10 pixels |
| bottom |
see Color Names |
| style |
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
The fields in the properties structure of Entire Visualizations are as follows:
|
Tag
|
Description
|
|---|---|
| location |
[x, y] normalized units |
| dimensions |
[width, height] normalized 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) |
Windows
The fields in the properties structure of Windows are as follows:
Examples
Version History
Introduced: 5.1
